接口设计说明
文件编号: 版本号: 受控状态: 保密级别: 编制人/编制时间: 审核人/审核时间: 批准人/批准时间: 生效日期:
KJXXW-XXSJ-M002-V1.0 V1.0
■ 受控 □ 非受控 公司级 王攀坤
2014年7月
新疆泰戈瑞信息技术有限责任公司 发布
新疆泰戈瑞信息技术有限责任公司
变更记录
变更 序号 1 变更 状态 C 简要说明变更内容和 版本号 变更范围 1.0 变更人 批准人 生效日期 (注:更改状态包括:C-创建、A-增加、M-修改、D-删除)
2 / 14
新疆泰戈瑞信息技术有限责任公司
目 录
1. 引言 .............................................................................................................................................................. 5
1.1 标识 ................................................................................................................................................... 5 1.2 系统概述 ........................................................................................................................................... 5 1.3 文档概述 ........................................................................................................................................... 5 1.4 基线 ................................................................................................................................................... 6 2. 引用文件 ...................................................................................................................................................... 7 3. 系统级设计决策 ........................................................................................................... 错误!未定义书签。 4. 系统体系结构设计 ....................................................................................................... 错误!未定义书签。
4.1 系统总体设计 .................................................................................................... 错误!未定义书签。 4.1.1 概述 ............................................................................................................ 错误!未定义书签。 4.1.2 设计思想 .................................................................................................... 错误!未定义书签。 4.1.3 基本处理流程 ............................................................................................ 错误!未定义书签。 4.1.4 系统体系结构 ............................................................................................ 错误!未定义书签。 4.1.5 功能需求与系统配置项的关系................................................................. 错误!未定义书签。 4.1.6 人工处理过程 ............................................................................................ 错误!未定义书签。 4.2 系统部件 ............................................................................................................ 错误!未定义书签。 4.3 执行概念 ............................................................................................................ 错误!未定义书签。 4.4 接口设计 ............................................................................................................ 错误!未定义书签。 4.4.1 接口标识和图表 ........................................................................................ 错误!未定义书签。 4.4.2 (接口的项目唯一标识符) .......................................................................... 错误!未定义书签。 4.4.3 ……(同4.4.2) ....................................................................................... 错误!未定义书签。
5. 运行设计 ....................................................................................................................... 错误!未定义书签。
5.1 系统初始化 ........................................................................................................ 错误!未定义书签。 5.2 运行控制 ............................................................................................................ 错误!未定义书签。 5.3 运行结束 ............................................................................................................ 错误!未定义书签。
3 / 14
新疆泰戈瑞信息技术有限责任公司
6. 系统出错处理设计 ....................................................................................................... 错误!未定义书签。
6.1 出错信息 ............................................................................................................ 错误!未定义书签。 6.2 补救措施 ............................................................................................................ 错误!未定义书签。 7. 系统维护设计 ............................................................................................................... 错误!未定义书签。
7.1 检测点的设计 .................................................................................................... 错误!未定义书签。 7.2 检测专用模块的设计 ........................................................................................ 错误!未定义书签。 8. 尚待解决的问题 ........................................................................................................... 错误!未定义书签。 9. 需求的可追踪性 ........................................................................................................................................ 12 10. 注解 ............................................................................................................................................................ 13 附录 ................................................................................................................................................................. 14
4 / 14
新疆泰戈瑞信息技术有限责任公司
1. 引言
本章分为以下几条。
1.1 标识
【内容】
本条应包含本文档适用的系统和软件的完整标识,(若适用)包括标识号、标题、缩略词语、版本号和发行号。
【裁剪原则】
此部分内容不允许裁剪掉。
1.2 系统概述
【内容】
本条应简述本文档适用的系统和软件的用途。它应描述系统与软件的一般性质;概述系统开发、运行和维护的历史;标识项目的投资方、需方、用户、开发方和支持机构;标识当前和计划的运行现场;并列出其他有关文档。
【裁剪原则】
此部分内容不允许裁剪掉。
1.3 文档概述
【内容】
本条应概述本文档的用途和内容,并描述与其使用有关的保密性和私密性的要求。 【裁剪原则】
此部分内容不允许裁剪掉。
5 / 14
新疆泰戈瑞信息技术有限责任公司
1.4 基线
【内容】
说明编写本系统设计说明书依据的设计基线。 【裁剪原则】
此部分内容不允许裁剪掉。
6 / 14
新疆泰戈瑞信息技术有限责任公司
2. 引用文件
【内容】
本章应列出本文档引用的所有文档的编号、标题、修订版本和日期,本章也应标识不能通过正常的供货渠道获得的所有文档的来源。
【裁剪原则】
此部分内容不允许裁剪掉。
7 / 14
新疆泰戈瑞信息技术有限责任公司
3. 接口设计
【内容】
本章应分条描述一个或多个系统、子系统、配置项、手工操作和其他系统部件的接口特性。如果设计的部分或全部依赖于系统状态或方式,则应指出这种依赖性。如果设计信息在多条中出现,则可只描述一次,而在其他条加以引用。如果此信息的部分或全部在别处提供,则此处可以引用。应给出或引用为了理解设计所需的设计约定。
【裁剪原则】
此部分内容不允许裁剪掉。
3.1 接口标识和接口图
【内容】
对于1.1中所标识的每个接口,本条应陈述赋予该接口的项目唯一标识符,(若适用)并用名字、编号、版本和文档引用等标识接口实体(系统、配置项、用户等)。该标识应说明哪些实体具有固定的接口特性(因而要对这些接口实体强加接口需求),哪些实体正被开发或修改(从而已将接口需求施加于它们)。(若适用)可用一个或多个接口图来描述这些接口。
【裁剪原则】
此部分内容不允许裁剪掉。
3.2 (接口的项目唯一标识符)
【内容】
本条(从3.2开始编号)应通过项目唯一标识符标识接口,应简要标识接口实体,并且应根据需要划分为几条描述接口实体的单方或双方的接口特性。如果一给定的接口实体本文没有提及(例如,一个外部系统),但是其接口特性需要在本文描述的接口实体时提到,则这些特性应以假设、或“当[未提到实体]这样做时,[被提到的实体]将……”的形式描述。本条可引用其他文档(例如数据字典、协议标准、用户接口标准)代替本条的描述信息。(若适用)本设计说 8 / 14
新疆泰戈瑞信息技术有限责任公司
明应包括以下内容,它们可按适合于要提供的信息的任何次序给出,并且应从接口实体角度指出这些特性之间的区别(例如数据元素的大小、频率或其他特性的不同期望)。
a.接口实体分配给接口的优先级别;
b.要实现的接口的类型(如:实时数据传送、数据的存储和检索等);
c.接口实体必须提供、存储、发送、访问、接收的单个数据元素的特性,如: 1) 名称/标识符; a)项目唯一标识符; b)非技术(自然语言)名称; c)标准数据元素名称;
d)技术名称(如代码或数据库中的变量或字段名称); e)缩写名或同义名;
2) 数据类型(字母数字、整数等);
3) 大小和格式(如:字符串的长度和标点符号); 4) 计量单位(如:米、元、纳秒); 5) 范围或可能值的枚举(如:0-99); 6) 准确度(正确程度)和精度(有效数字位数);
7) 优先级别、时序、频率、容量、序列和其他的约束条件,如:数据元素是否可被更新和业务规则是否适用; 8) 保密性和私密性的约束;
9) 来源(设置/发送实体)和接收者(使用/接收实体);
d.接口实体必须提供、存储、发送、访问和接收的数据元素集合体(记录、消息、文件、 9 / 14
新疆泰戈瑞信息技术有限责任公司
显示和报表等)的特性,如:
1) 名称/标识符; a)项目唯一标识符; b)非技术(自然语言)名称;
c)技术名称(如代码或数据库的记录或数据结构); d)缩写名或同义名;
2) 数据元素集合体中的数据元素及其结构(编号、次序和分组); 3) 媒体(如盘)和媒体中数据元素/数据元素集合体的结构;
4) 显示和其他输出的视听特性(如:颜色、布局、字体、图标和其他显示元素、蜂鸣声、亮度等);
5) 数据元素集合体之间的关系,如排序/访问特性;
6) 优先级别、时序、频率、容量、序列和其他的约束条件,如:数据元素集合体是否可被修改、业务规则是否适用; 7) 保密性和私密性约束;
8) 来源(设置/发送实体)和接收者(使用/接收实体); e.接口实体必须为接口使用通信方法的特性。如: 1) 项目唯一标识符;
2) 通信链接/带宽/频率/媒体及其特性; 3) 消息格式化;
4) 流控制(如:序列编号和缓冲区分配); 5) 数据传送速率,周期性/非周期性,传输间隔;
10 / 14
新疆泰戈瑞信息技术有限责任公司
6) 路由、寻址、命名约定; 7) 传输服务,包括优先级别和等级;
8) 安全性/保密性/私密性方面的考虑,如:加密、用户鉴别、隔离和审核等; f.接口实体必须为接口使用协议的特性,如: 1) 项目唯一标识符; 2) 协议的优先级别/层次;
3) 分组,包括分段和重组、路由、寻址; 4) 合法性检查、错误控制和恢复过程; 5) 同步,包括连接的建立、维护、终止; 6) 状态、标识、任何其他的报告特征;
g.其他所需的特性,如:接口实体的物理兼容性(尺寸、容限、负荷、电压和接插件兼容性等)。
【裁剪原则】
此部分内容不允许裁剪掉。
3.3 ……(同3.2)
11 / 14
新疆泰戈瑞信息技术有限责任公司
4. 需求的可追踪性
【内容】 本章应包括:
a、 从本文提到的每个接口实体到该实体的接口设计所涉及的系统或CSCI需求的可追踪性;
b、 从影响本IDD所覆盖的接口的每个系统或CSCI需求到涉及它的接口实体的可追踪性。
【裁剪原则】
此部分内容不允许裁剪掉。
12 / 14
新疆泰戈瑞信息技术有限责任公司
5. 注解
【内容】
本章应包含有助于理解本文档的一般信息(例如原理)。本章应包含为理解本文档需要的术语和定义,所有缩略语和它们在文档中的含义的字母序列表。
【裁剪原则】 不允许裁剪掉。
13 / 14
新疆泰戈瑞信息技术有限责任公司
附录
【内容】
附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理附录可单独装订成册。附录应按字母顺序(A,B等)编排。
【裁剪原则】 不允许裁剪掉。
14 / 14
因篇幅问题不能全部显示,请点此查看更多更全内容