软件系统概要设计说明书
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
系统概要设计说明书
项目名称:
编写:
审核:
批准:
日期:
修订历史记录
目录
1概述 (5)
1.1项目背景 (5)
1.2编写目的 (5)
1.3编写原则 (5)
1.4术语定义 (5)
2总体设计 (6)
2.1设计目标 (6)
2.2技术路线 (6)
2.3系统总体架构 (7)
2.4系统功能架构 (7)
3功能界面控制组件设计 (7)
3.1界面控制组件层次图 (7)
3.2界面控制组件一览表 (7)
3.3界面控制组件清单 (7)
3.4UIC01_001/需求管理 (8)
3.4.1组件说明 (8)
3.4.2子控制组件层次图 (8)
3.4.3子控制组件列表 (9)
3.4.4UIC08_001_001/编制年度需求计划 (9)
4功能逻辑组件设计 (9)
4.1逻辑组件一览表 (9)
4.2逻辑控制组件清单 (10)
4.3LC08_001/选购管理 (10)
4.3.1组件说明 (10)
4.3.2子组件列表 (10)
4.3.3LC08_001_001/需求计划管理 (11)
4.3.3.1实体关系 (11)
4.3.3.2实体列表 (11)
4.3.3.3组件设计卡片 (12)
5接口设计 (13)
5.1XXXX系统接口 (13)
5.1.1XXXX接口 (13)
5.1.1.1应用场景 (13)
5.1.1.2交互流程 (13)
5.1.1.3接口定义 (14)
5.1.1.4接口交互数据 (14)
5.2XXXX系统接口 (14)
5.2.1XXXX接口 (14)
5.3中间库表设计说明 (15)
5.3.1XXXX表 (15)
1概述
1.1项目背景
【编写内容】
在此处描述项目背景信息,例如项目来源、建设现状、存在问题、必要性说明等内容。
【正文格式】
要求:首行缩进2字符,宋体,小四,行距1.5
【描述方法】
整段描述
1.2编写目的
【编写内容】
编写这份概要设计说明书的目的、适用范围。
如不存在集成设计或安全设计需在此处说明。
【正文格式】
要求:首行缩进2字符,宋体,小四,行距1.5
【描述方法】
<序号>、<目的描述>
1.3编写原则
【编写内容】
在此处说明文档的编写要求,非系统建设原则。
例如:
1、文档仅限四级标题。
【正文格式】
要求:首行缩进2字符,宋体,小四,行距1.5
【描述方法】
<序号>、<目的描述>
1.4术语定义
【编写内容】
在此处说明文档的术语定义。
例如:
1、业务架构:是信息化总体架构的起点,业务架构定义了在总体企业战略指导下希望实现的业务能力及其关系。
【正文格式】
要求:首行缩进2字符,宋体,小四,行距1.5
【描述方法】
<序号>、<术语名称>:<术语描述>
2总体设计
2.1设计目标
【编写内容】
在此处说明系统总体设计目标。
【正文格式】
要求:首行缩进2字符,宋体,小四,行距1.5
【描述方法】
<序号>、<术语名称>:<术语描述>
2.2技术路线
2.3 系统总体架构
附图
2.4 系统功能架构
包括系统总体功能结构图及系统功能列表
3 功能界面控制组件设计
3.1 界面控制组件层次图
3.2 界面控制组件一览表
3.3
界面控制组件清单
3.4UIC01_001/需求管理
3.4.1组件说明
本组件是对选购管理各项业务实现方式的抽象描述。
主要实现选购业务所包含的各项业务的界面操作。
具体包括:编制年度需求计划、编制月度需求计划、需求审核、需求审批、需求计划生效、建立供应商与产品目录、抽取样品、选型试验、评测结果、编制设备订货清单、签定技术协议和设备订货清单打印。
3.4.2子控制组件层次图
3.4.3子控制组件列表
3.4.4UIC08_001_001/编制年度需求计划
4功能逻辑组件设计
4.1逻辑组件一览表
4.2逻辑控制组件清单
4.3LC08_001/选购管理
4.3.1组件说明
本组件通过同类抽象的原则,对选购管理各个业务子项的功能点设计进行抽象描述。
主要实现选购管理各个业务子项界面操作所需的功能。
具体功能包括:需求计划管理、建立供应商与产品目录、抽取样品、评测结果、编制设备订货清单、需求审核、审批、签定技术协议、设备订货清单打印、订货合同管理。
4.3.2子组件列表
4.3.3 LC08_001_001/需求计划管理
4.3.3.1 实体关系
4.3.3.2 实体列表
4.3.3.3组件设计卡片
【方法说明】
在计划年度下,如果已存在电能表、互感器、采集终端和计量标准装置及计量
标准器的需求计划数据进行提取显示。
【输入参数】
计划年度/月度、管理单位、计划状态、管理单位
【处理过程】
获取查询条件:
(1)计划年度/月度=当前年月;
(2)管理单位=操作员所在单位;
(3)如果当前界面是需求审核、需求审批和需求计划生效,对应计划状态分别
是:到审核、待审批和待生效。
根据计划年度/月度、管理单位和计划状态,查找(D_DMD_PLAN/需求计划信息),如果找到相应信息,则根据该信息的计划编号和设备类别做如下查询:(1)如果设备类别=电能表
查找(D_METER_REQ_PLAN/电能表需求计划明细),并返查询结果。
(2)如果设备类别=互感器
查找(D_IT_REQPLAN_DETAIL/互感器需求计划明细),并返查询结果。
(3)如果设备类别=采集终端或计量标准装置及计量标准器
查找(D_OTHERDEV_DMD_PLAN/其它设备需求计划明细),并返查询结果。
【输出参数】
『需求计划信息』(08_001_001)
需求计划明细信息
(1)如果设备类别=电能表
『需求计划明细(电能表)信息』(08_001_002);
(2)如果设备类别=互感器
『需求计划明细(互感器)信息』(08_001_003);
(3)如果设备类别=采集终端或计量标准装置及计量标准器
『需求计划明细(其它设备)信息』(08_001_004)。
5接口设计
5.1XXXX系统接口
5.1.1XXXX接口
5.1.1.1应用场景
描述该接口所涉及的具体业务使用场景,示例如下:
采集运维模块发现采集主站档案与营销系统档案不一致时,采集运维模块通过此接口向采集主站发起档案同步请求,采集系统根据请求内容将与现场通讯相关的营销档案同步至采集主站数据库,同步完成后将同步结果反馈采集运维模块。
5.1.1.2交互流程
包括交互流程图及交互流程说明,交互流程说明针对具体的交互逻辑进行描述,如果采用了中间库进行数据交互,且中间库中的关键字段决定或影响了交互逻辑,需详细描述清楚。
示例如下:
(1)交互流程图
(2)交互流程说明
采集运维模块将同步信息(户号、终端资产号、电表资产号等)写入双方约定的中
间表,并调用WebService接口服务(WS_SYNC_NOTICE)通知用电信息采集系统。
用电信息采集系统收到通知后,返回WebService调用,分析是否能够执行此请求。
用电信息采集系统采用异步方式,根据任务批次号从中间表获取需同步的方案。
用电信息采集系统解析方案执行营销与采集系统的档案同步操作,同步完成后更新中间表状态。
采集运维平台发出通知后定时扫描中间表,直至获取所需结果
5.1.1.3接口定义
5.1.1.4接口交互数据
针对需通过中间库完成数据交互的接口方式,需提供接口交互中间表信息列表,如果未采用中间库方式交互信息,可忽略次章节。
具体示意如下:
5.2XXXX系统接口
5.2.1XXXX接口
……
5.3中间库表设计说明
针对采用中间库进行数据交互的接口方式,需对涉及的中间库表进行设计说明,各表中的关键字段需在“说明”列中详细描述,对存在编码的字段,需列出具体的编码值。
5.3.1XXXX表。