1 概述
本章阐述了S1000D中存在的业务规则类别和层的概念。
将业务规则分组为类别将有助于项目和组织区分和理解各种业务规则的相关性,并能够将其分组为某些类。进行此分类是为了帮助标准化业务规则范围。
S1000D认识到,与其实施相关的许多决定不仅在项目层面做出,而且往往在组织层面做出 (例如,国家部委或国防部 (MoD or DoD),国际财团,如民航工作组 (CAWG))。项目和各种组织之间的业务规则的结构和内容可能会有很大差异。
为了支持业务规则类别,引入了业务规则的分层模型。
分层模型的引入意味着不仅可以为项目编写业务规则,还可以为组织编写业务规则。业务规则的各个层可以安排在适合实现的层次结构中。层次结构的每一层都代表项目或组织要做出的一些业务规则决策。
不同层级上的业务规则可能包含冗余和/或冲突的业务规则。此外,业务规则的分层结构通常具有树状结构,而不是一维分层形式。较低级别的业务规则层次结构所依赖的更高级别的业务规则的任何更改都可能与其他层的相关业务规则相冲突。本章第5段指出了业务规则创建中的各种方面的冲突,并提供了避免这些冲突的指导和建议。
2 业务规则类别
业务规则类别是一个独特的分组,描述适用于产品定义、维护理念、操作概念、安全性、业务流程、数据创建、数据交换、数据完整性、数据输出和/或遗留数据转换、管理、处理和其他问题。
已经确定了十个不同的业务规则类别。定义这些类别是为了确保业务规则开发人员考虑S1000D内的所有主要业务规则决策。每个业务规则类别都对应业务规则示例。某些业务规则可以属于一个或多个类别。除此之外,业务规则类别不能孤立地考虑。它们相互关联并相互补充 (例如,数据交换、数据完整性和管理业务规则类别,如第2.8段所示,以及数据创建和数据输出业务规则类别,如第2.10段所示)。业务规则类别在图1中标识。
Fig1 业务规则类别
在第2.1段至第2.10段中,每个业务规则类别的定义之后给出的示例并非详尽,仅旨在为读者提供如何涵盖这些规则类别的指南。在本例中,“必须” 一词意味着某个业务规则必须仅由该特定示例项目或组织遵循。
2.1 业务规则类别1 - 总体业务规则
2.1.1 定义
总体业务规则涵盖以下任何特定业务规则类别未涵盖的项目或组织做出的所有决策。它们是实施S1000D的总体决策。
这些决定包括但不限于:
- 关于S1000D实施哪个问题的决定
- 确定要在项目中使用和实施的S1000D零件
- 定义整个项目中使用的术语,因此对它们的含义要有一个清晰的理解
2.1.2 示例
- 组织级别的决策示例: 所有新车的技术文件必须在S1000D 4.0或更高版本中制作。
- 项目级别的决策示例: 项目的全部技术文档必须在S1000D 2.1的基础上实现。例外/添加: 布线的创作规则将从S1000D 2.2开始采用。布局规则将在S1000D发行2.3的基础上实施。
2.1.3 业务规则类别1-总体业务
以下业务规则是基本规则,在解决任何其他业务规则之前必须先确定:
业务规则决策点BRDP-S1-00003-要使用的S1000D问题:
- 决定使用哪个或哪个版本的S1000D
业务规则决策点BRDP-S1-00004-要使用的信息集:
- 确定要使用S1000D和/或特定于项目的哪些信息集
业务规则决策点BRDP-S1-00005-要制作的出版物:
- 决定要制作哪些出版物。
业务规则决策点BRDP-S1-00006-要使用的Schema文件:
- 确定要使用的Schema文件以及要在哪个信息集中使用它们。
业务规则决策点BRDP-S1-00007-可选元素和属性的使用:
- 决定是否以及如何在其结构上下文中使用每个可选元素和属性。
业务规则决策点BRDP-S1-00008-可能的可交付成果:
- 决定可能的可交付成果,例如: 。 使用基于文件传输的S1000D对象 (例如,数据模块,发布模块,插图表和多媒体对象,数据管理列表) 。请参阅第7.5.1章。 。面向页面的出版物和/或交互式电子技术出版物。
2.2 业务规则类别2 - 产品定义业务规则
2.2.1 定义
产品定义业务规则涵盖了与产品如何分解 (例如,物理或功能) 相关的数据模块编码策略。包括要在产品及其子系统中使用的型号识别码的定义。还需要考虑供应商子系统和标识。
项目特定的SNS通常与工程或设计定义的产品细分结构一起定义。SNS规范是为详细说明这些规则而产生的一组信息。
适用性规则也在此类别中定义。
此外,区域和接入点的定义属于这一类别。
综上所述,产品定义业务规则包括但不限于:
- 产品及其子系统和组件的型号识别码
- 系统差异代码
- 材料项目类别代码
- SNS规范 (决定选择或定义哪个SNS方案)
- 拆卸代码
- 拆装代码变化
- 适用性规则
- 分区规则
- 访问规则
2.2.2 示例
- 与产品细分相关的数据模块编码策略的规则在项目BREX数据模块中定义
- 该项目的允许型号识别码为机身 “1B”,发动机为 “E2”
- 在数据模块中给出了SNS列表以及技术名称和数据模块类型,数据模块代码为DMC-YY-…
- 适用规则如下:
- 自行车的型号必须是 “Brook trekker” 或 “Mountain storm”
- 自行车的版本必须是 “Mk1” 或 “Mk9”
- 序列号必须是 “001” 到 “999”
- 区域和访问点遵循第3.4章中给出的分区和访问规则,或者在项目定义的产品的特定文档中进行了详细说明
2.3 业务规则类别3 - 运营业务规则的维护理念和概念
2.3.1 定义
运营业务规则的维护理念和概念涵盖了项目或组织所需的信息类型。例如,它们包括所选信息集的列表或详细规格,详细说明信息代码的信息代码规格以及描述数据模块内容的信息名称。
还包括所需物品位置代码的定义。
运营业务规则的维护理念和概念由合同确定(例如,要交付的是第一,第二和第三维护级别信息?)。
这些规则的定义必须与操作,可维护性,维修和LSA其他方面一起执行。
信息代码、信息代码变体和物品位置代码定义的数据模块编码策略都包含在此类别中。这样可以确保信息代码,信息代码变体和项目位置代码与总体业务规则类别 (业务规则类别1) 中技术文档细分中的每个级别的产品定义相匹配。
培训和技能水平也按此类别定义或标识。
综上所述,运营业务规则的维护理念和概念包括但不限于:
- 第5章中给出的相关信息集列表或修改后的信息集
- 项目特定信息集的详细规范
- 项目中使用的信息代码和信息名称的列表或详细说明
- 要使用的项目位置代码
- 根据维护级别指定要传递的信息的深度
- 将信息代码和项目位置代码与数据模块代码的细分部分匹配,如产品定义业务规则 (业务规则类别2) 中定义的那样
- 关于如何应用信息代码变体的决定
- 培训和技能水平
2.3.2 示例
- 给出了允许的信息代码列表以及信息名称和数据模块类型
- 给出了数据模块代码的分解部分之间的映射 (型号识别码,系统差异码,SNS,反汇编码和反汇编码变体)和数据模块代码的信息部分 (信息代码,项目代码变体和项目位置代码) 以及数据模块类型
2.4 业务规则类别4-安全业务规则
2.4.1 定义
安全业务规则涵盖所有安全问题和知识产权。它们包括安全分类、版权标记、使用或披露限制、销毁指示和任何其他数据限制。
还有关于数据创建访问的问题。例如,在多合作伙伴项目中,产品被分解为责任领域。多个合作伙伴的组织可能意味着仅向数据模块的设计机构提供写的访问权限。
这里必须考虑有关生产过程中数据访问的规则(例如,允许谁编辑数据模块或插图?)。重要的是首先建立这些规则。这些规则不解释工作角色,职位和问责制/责任,但定义了哪些角色在查看,创建和修改数据方面具有哪些权利。
必须特别考虑国家安全限制。
使用项目安全指令执行安全业务规则的创建。
总而言之,安全业务规则包括但不限于:
- 安全分类及其使用定义
- 版权标记
- 披露的使用
- 销毁说明和合适的方法
- 国家安全限制
- 特定项目安全说明 (如果有)
- 其他限制
- 对各种 “类” 数据模块的访问规范
2.4.2 示例
- 安全分类属性的值及其解释列于表格中
- LP压缩机数据模块必须始终受到北大西洋公约组织 (NATO) 的限制
- 不得使用内联安全标记
- 只有公司A的作者被允许与负责的合作伙伴公司B编辑/查看数据模块,当他们位于彼得伯勒办公室
- 标有 “NATO Restricted” 的数据模块不得与C公司交换
2.5 业务规则类别5-业务流程业务规则
2.5.1 定义
业务流程业务规则涵盖了技术出版物开发如何与组织内或该组织或整个项目的项目级别内的其他学科协调。例如,它们描述了与LSA,S2000M规范,兼容的初始配置,工程/设计和培训 (例如,SCORM一致性) 的规则和关系。
必须考虑质量保证的规则以及组织、其合作伙伴和供应商之间的互动。
当需要使用S1000D生成培训内容时,必须建立规则,以满足教学设计师 (在学习方面) 和支持通用系统的作者 (在维护和操作方面) 的内容开发需求。
此外,必须建立业务规则和流程,以确保教学设计师和技术作者协作预先计划可重用的内容。
这些规则还考虑了数据模块编码策略,以实现:
- 培训产品中屏幕演示的最佳可重用数据粒度和IETP中演示的系统维护理念
- 开发用于交互式多媒体和模拟的维护,操作和学习内容
- 开发适当数量的数据模块的过程,以满足SCORM中的SCO的预期需求
- 数据模块/发布模块代码与学习内容注册要求的关系
综上所述,业务流程业务规则包括但不限于:
- 其他学科在技术出版物中的输入和输出定义
- 可交付成果的项目层次结构顺序和分包商的投入
- 制造商、分包商和客户之间商定的工作流程
- 经批准的与外部系统 (如物流数据库) 的集成方法
- 关于组织、其合作伙伴和供应商之间与质量保证相关互动的验证规则
- 预先规划、可重用性和互操作性规则
2.5.2 示例
- 将LSA任务代码映射到数据模块代码时,以下规则适用…
- 从CAD系统中提取的图形必须使用这些参数用于出版物...
- 当数据模块准备好交换时,它必须收到工程公司的验证证书。收到此消息后,将数据模块标记为first verified
- 当客户提供验证证书时,增加问题类型为 “状态” 的数据模块的问题编号,并将QA设置为second verified
- 数据模块已准备好在此特定点进行质量检查,这些是测试要遵循的步骤
- 初始配置数据必须按照S2000M 6.0进行编码
- IPD Schema中下列元素和属性的值必须从S2000M 4.0,第1章初始设置导入
- 培训数据模块必须仅使用以下学习代码…
2.6 业务规则类别6-数据创建业务规则
数据创建业务规则提供有关创建文本,插图和多媒体对象的信息。
数据创建业务规则包括:
- 创建文本数据的规则
- 创建图形、3D内容和多媒体对象的规则
2.6.1 业务规则类别6a -数据创建业务规则-文本
2.6.1.1 定义
文本创建业务规则由规则和指南 (包括语言和字典等术语规则,以及偏好顺序) 组成,最大限度地提高技术出版物中以及技术出版物和支持培训内容之间的重用量。
文本创建业务规则提供了有关如何开发技术和学习内容的规则和指导。他们还规定,例如,字典的使用,数字必须如何表达,作者必须如何参考技术术语,多媒体、维护、操作和学习内容如何支持IETP和培训,以及建立和使用术语数据库。
标记业务规则提供了有关必须使用和填充哪些标记元素和属性的信息。这些规则通常是特定于项目或组织的。
综上所述,文本的数据创建业务规则包括但不限于:
- 写作规则 (包括术语规则、字典使用、数字规则等)
- 标记规则
- 多媒体对象中文本合并的要求
2.6.1.2 示例
- 必须使用ASD-STE100的简化技术英语 (STE) 词典。
- 给出了技术术语列表…
- 所有故障数据模块的故障代码必须在故障代码索引中列出
- 支持设备清单,备件清单和耗材清单中使用的名称必须是S2000M数据库中指定的全名。在过程中参考这些工具,备件或用品时,请使用这些相应的名称。
- 适用性块标记要求是…
- 元素
不得使用
2.6.2 业务规则类别6b -数据创建业务规则-插图和多媒体
2.6.2.1 定义
插图和多媒体创作业务规则涵盖了插图和多媒体对象的创作。它们分为样式,细节和数据格式。
插图和多媒体对象的数据样式规则控制着诸如插图大小,颜色,线条权重,字体,投影方法 (等距或三度) 之类的特征。
插图规则涵盖了热点的使用。
数据格式规则涵盖了信息必须存储的格式。对于CGM插图,这将涵盖允许的元素 (例如,坐标类型,折线,受限文本)。对于光栅图像,它可以包括分辨率和方向。通常很难将样式与格式分开。
综上所述,插图和多媒体对象的数据创建业务规则包括但不限于:
- 图形样式规则
- 交互细节规则
- 多媒体格式规则
- 链接规则
2.6.2.2 示例
- 2D的规则是…
- 3D的规则是…
- 三度投影必须用于…
- 照片被允许...
- 联合摄影专家组 (JPEG) 格式必须用于…
- 图像尺寸必须是…
- 光栅图像分辨率必须至少为300dpi
- 模拟将在Flash™中产生
2.7 业务规则类别7-数据交换业务规则
2.7.1 定义
业务规则第7类涵盖了合作伙伴和客户之间如何交换数据的规则。例如,这包括使用数据收发说明以及如何使用数据管理需求列表以及CSDB状态列表。此类别中的规则包括如何使用基于S1000D文件的传输协议,数据交换的频率,如果交换未经验证的数据,则数据模块和图形发布编号的规则以及接受和拒绝的标准。
综上所述,数据交换业务规则包括但不限于:
- 数据收发说明的使用规则
- 数据管理需求列表的使用规则
- CSDB状态列表的规则
- 基于文件的传输协议的使用规则
- 关于数据交换频率的协议
- 数据模块问题编号规则
- 用ICN编码的信息对象的规则
- 同意接受和拒绝的标准
业务规则决策点BRDP-S1-00009-数据交换频率:
- 决定数据交换的频率。
2.7.2 示例
- 必须使用基于S1000D文件的传输方法交换数据
- 注释和数据管理列表必须在单独的软件包中交换
- 数据收发说明必须符合以下业务规则…
- 数据模块交付将在每个日历月进行一次
- 在每次交换之后,必须生成并验证CSDB状态列表,然后才能进行任何进一步的交换。CSDB状态列表的业务规则是…
- 不允许交换未经验证的信息
2.8 业务规则类别8-数据完整性和管理业务规则
2.8.1 定义
数据完整性和管理业务规则在CSDB中强制执行引用完整性。与数据交换业务规则紧密结合 (请参阅第2.7段),它们涵盖了创建者和客户如何管理数据。
如有必要,此类别可以包括定义在供应商无法生成符合S1000D的数据时提交和接受不符合要求的数据过程的规则。
工作流业务规则 (内部和外部) 以及QA的规则也包含在此类别中。这些也连接到数据交换业务规则。
综上所述,数据完整性和管理业务规则包括但不限于:
- 工作流业务规则 (包括内部和外部)
- QA业务规则
2.8.2 示例
- 不允许数据模块问题编号中的空白
- 除非exchange软件包中包含所有引用的插图,否则将不接受任何数据模块
- 所有数据模块和图形必须通过业务规则标准才能被接受
2.9 业务规则类别9-遗留数据转换、管理和处理业务规则
2.9.1 定义
遗留数据转换,管理和处理业务规则与上述其他类别完全分开,并且可以 (在某种程度上) 被认为不在S1000D的范围之内。它们涵盖了将数据从例如ATA iSpec 2200项目转换为数据模块的规则,并且将根据源数据 (文字处理器,纸张,SGML,XML) 的格式以及目标数据模块的处理方式而有所不同。
综上所述,遗留数据转换业务规则包括但不限于:
- 转换规则,包括源和目标规范的元素和属性之间的映射
- 将遗留信息纳入技术出版物的规则
2.9.2 示例
- 维护手册将使用descriptive和procedure schemas转换为数据模块
- 以下ICN代码适用于操作员手册第XYZ号
2.10 业务规则类别10-数据输出业务规则
2.10.1 定义
数据输出业务规则指定S1000D数据的输出格式。这些格式可以包括面向页面的 (如纸张、pdf) 格式、IETP格式、多媒体格式和SCORM格式。关于将发布数据的哪一部分以及以何种格式发布的决定必须在这些业务规则内达成一致并编写。
这些规则包括有关如何显示元素和属性内容的详细信息。数据创建业务规则 (尤其是文本,业务规则类别6a) 与该业务规则类别密切相关。例如,作者需要知道在哪些元素中生成了文本,以避免在出版物生成后产生冗余和不一致。
在需要时,根据S1000D功能矩阵给出的建议创建项目功能矩阵 (参考第6.4章)。在完成项目功能矩阵时做出的决策将直接影响数据输出规则。
综上所述,数据输出业务规则包括但不限于:
- 关于哪一部分必须在纸上 (或面向页面),哪一部分必须在IETP中做出决定
- 纸张(或面向页面)和IETP输出的显示规则
- 关于哪些数据模块将以SCORM格式输出的决策
- 关于哪些数据模块将在模拟中输出的决策
- 查看和感觉业务规则
2.10.2 示例
- 第6.2章中的S1000D标准面向页面的布局必须用于面向页面的演示
- 对于从IETP打印的硬拷贝,必须在每页的内页边上打印以下时间过期消息: “此页是工作副本。2017-03-15后不得使用”。
- 所有学习数据模块将以SCORM格式输出
- 维护数据将被纳入系统模拟
- 警告必须根据第6.2.2章中描述的符号警告类型
- 具有前缀 “pfXX” 的随机列表项目元素必须在项目或项目的第一个项目符号之前打印26 pt项目符号字符 (•)
- 打印输出的页面大小为A4,文件夹为A3
< 回到目录