软件系统概要设计说明书.docx
- 文档编号:7576614
- 上传时间:2023-01-25
- 格式:DOCX
- 页数:14
- 大小:153.94KB
软件系统概要设计说明书.docx
《软件系统概要设计说明书.docx》由会员分享,可在线阅读,更多相关《软件系统概要设计说明书.docx(14页珍藏版)》请在冰豆网上搜索。
软件系统概要设计说明书
系统概要设计说明书
项目名称:
编写:
审核:
批准:
日期:
修订历史记录
版本
*变化状态
说明
日期
修订者
*变化状态(A-添加,M-修改,D-删除)
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技术路线
分类
选型原则
技术选型
界面展现技术:
HTML、JSP、Flex、JavaScript
服务器开发技术:
JDK1.5、JavaEE5.0
数据访问技术:
JDBC
部署模式
华为云部署
开发平台
*****应用平台
中间件
应用服务器:
Weblogic
分析决策工具:
Cognos
ETL工具:
Informatica
数据仓库、数据集市:
SybaseIQ
企业服务总线:
OSB
数据库
Oracle10g
操作系统
Windows、Linux、Unix
2.3系统总体架构
附图
2.4系统功能架构
包括系统总体功能结构图及系统功能列表
3功能界面控制组件设计
3.1界面控制组件层次图
3.2界面控制组件一览表
组件编号/组件名称
组件说明
UIC01_001/选购管理
本组件是对选购管理各项业务实现方式的抽象描述。
主要实现选购业务所包含的各项业务的界面操作。
具体包括:
编制年度需求计划、编制月度需求计划、需求审核、需求审批、需求计划生效、建立供应商与产品目录、抽取样品、选型试验、评测结果、编制设备订货清单、签定技术协议和设备订货清单打印。
3.3界面控制组件清单
业务项
需求功能模块
界面控制组件
备注
BM08_001_001/需求计划管理
F03_001/编制年度需求计划
UIC01_001_001/编制年度需求计划
……
……
……
3.4UIC01_001/需求管理
3.4.1组件说明
本组件是对选购管理各项业务实现方式的抽象描述。
主要实现选购业务所包含的各项业务的界面操作。
具体包括:
编制年度需求计划、编制月度需求计划、需求审核、需求审批、需求计划生效、建立供应商与产品目录、抽取样品、选型试验、评测结果、编制设备订货清单、签定技术协议和设备订货清单打印。
3.4.2子控制组件层次图
3.4.3子控制组件列表
子组件
组件描述
UIC08_001_001/编制年度需求计划
本组件提供本单位的年度资产需求计划,如果存在下级单位,还提供针对下级单位的汇总分析。
3.4.4UIC08_001_001/编制年度需求计划
组件名称
UIC08_001_001/编制年度需求计划
英文名
UIC_ReqYearPlanCreat
组件说明
本组件提供本单位的年度资产需求计划,如果存在下级单位,还提供针对下级单位的汇总分析。
原型图
约束
包括输入约束、操作约束等,例如输入数据长度、大小等,删除操作提示等内容,结合需求规格说明书具体功能描述中的处理约束、提示信息
方法
交互场景设计
初始化
操作员输入计划年度和设备类别,点击编制按钮,调用[需求计划管理(LC08_001_001):
:
需求计划编制],根据返回结果,系统显示电能表/互感器年度需求计划及计划明细。
计划处理
操作员输入计划年度和设备类别,点击编制按钮,调用[需求计划管理(LC08_001_001):
:
需求计划编制],根据返回结果,系统显示电能表/互感器年度需求计划及计划明细;
4功能逻辑组件设计
4.1逻辑组件一览表
组件编号/组件名称
组件说明
LC08_001/选购管理
本组件通过同类抽象的原则,对选购管理各个业务子项的功能点设计进行抽象描述。
主要实现选购管理各个业务子项界面操作所需的功能。
具体功能包括:
需求计划管理、建立供应商与产品目录、抽取样品、评测结果、编制设备订货清单、需求审核、审批、签定技术协议、设备订货清单打印、订货合同管理。
4.2逻辑控制组件清单
界面控制组件
逻辑组件
备注
UIC08_001_001/编制年度需求计划
LC08_001_001/需求计划管理
4.3LC08_001/选购管理
4.3.1组件说明
本组件通过同类抽象的原则,对选购管理各个业务子项的功能点设计进行抽象描述。
主要实现选购管理各个业务子项界面操作所需的功能。
具体功能包括:
需求计划管理、建立供应商与产品目录、抽取样品、评测结果、编制设备订货清单、需求审核、审批、签定技术协议、设备订货清单打印、订货合同管理。
4.3.2子组件列表
组件编号/组件名称
组件说明
LC08_001_001/需求计划管理
本组件是对需求计划管理功能点设计的抽象描述,提供计划初始化、手工调整,计划汇总等功能。
需求计划初始化、初始形成计划判断、需求计划编制、计划加权调整、计划明细保存、采购计划初始化、采购计划保存、需求计划查询、采购计划查询、审核流程处理、审批流程处理等方法。
4.3.3LC08_001_001/需求计划管理
4.3.3.1实体关系
4.3.3.2实体列表
实体英文名/中文名称
简要说明
D_DMD_PLAN/需求计划信息
1)存放需求计划信息,本实体主要包括:
计划编号、计划周期、计划年月、制定部门、制定人员等属性。
2)通过需求计划管理业务,由录入产生记录。
3)该实体主要由需求计划管理业务使用。
4.3.3.3组件设计卡片
组件名称
LC08_001_001/需求计划管理
英文名
LC_ReqPlanManage
组件说明
本组件是对需求计划管理功能点设计的抽象描述,提供计划初始化、手工调整,计划汇总等功能。
需求计划初始化、初始形成计划判断、需求计划编制、计划加权调整、计划明细保存、采购计划初始化、采购计划保存、需求计划查询、采购计划查询、审核流程处理、审批流程处理等方法。
方法名称
组件方法精化设计
需求计划初始化
【方法说明】
在计划年度下,如果已存在电能表、互感器、采集终端和计量标准装置及计量标准器的需求计划数据进行提取显示。
【输入参数】
计划年度/月度、管理单位、计划状态、管理单位
【处理过程】
1.获取查询条件:
(1)计划年度/月度=当前年月;
(2)管理单位=操作员所在单位;
(3)如果当前界面是需求审核、需求审批和需求计划生效,对应计划状态分别是:
到审核、待审批和待生效。
根据计划年度/月度、管理单位和计划状态,查找(D_DMD_PLAN/需求计划信息),如果找到相应信息,则根据该信息的计划编号和设备类别做如下查询:
(1)如果设备类别=电能表
查找(D_METER_REQ_PLAN/电能表需求计划明细),并返查询结果。
(2)如果设备类别=互感器
查找(D_IT_REQPLAN_DETAIL/互感器需求计划明细),并返查询结果。
(3)如果设备类别=采集终端或计量标准装置及计量标准器
查找(D_OTHERDEV_DMD_PLAN/其它设备需求计划明细),并返查询结果。
【输出参数】
2.『需求计划信息』(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接口定义
接口名称
XXX接口
接口方式
WebService+中间表/WebService/Socket
方法名称
WS_XXXXXX
数据频度
实时/定时
输入参数中文名称
输入参数英文名称
参数格式
含义
批次编号
BATCH_NO
NUMBER(16)
批次号
返回数据中文名称
返回数据英文名
数据格式
含义
返回码
RLT_FLAG
VARCHAR2
(2)
1:
接收成功;0:
接收失败
信息描述
RLT_MEMO
VARCHAR2(255)
错误信息描述
5.1.1.4接口交互数据
针对需通过中间库完成数据交互的接口方式,需提供接口交互中间表信息列表,如果未采用中间库方式交互信息,可忽略次章节。
具体示意如下:
接口
数据类中文名
数据类英文名
配送申请接口
配送申请
DIST_APP_INFO
配送申请明细
DIST_APP_DET
订单响应跟踪
ORDER_REPLY_TRACK
单位与操作标识关系表
ORG_OPER_ID_RELA
5.2XXXX系统接口
5.2.1XXXX接口
……
5.3中间库表设计说明
针对采用中间库进行数据交互的接口方式,需对涉及的中间库表进行设计说明,各表中的关键字段需在“说明”列中详细描述,对存在编码的字段,需列出具体的编码值。
5.3.1XXXX表
中文名
英文名
类型
说明
操作标识
OPER_ID
NUMBER(16)
通过GetOperId函数获取
申请编号
APP_NO
String
申请编号,即直配中的订单编号
审批标识
APPR_ID
String
审批标识
申请人
Applicant_no
String
申请人
申请日期
APP_DATA
String
申请日期
需求类型
DEMAND_TYPE_CODE
String
需求类型
需求月份
DEMAND_MONTH
String
部门编码
DEPT_NO
String
供电单位编号
ORG_NO
String
供电单位编号
设备类别
EQUIP_CATEG
String
设备类别
配送类型
DIST_TYPE_CODE
String
01:
正常、02:
申校返回、03:
报废鉴定返回、04:
委托鉴定配送、05:
配送质量核查配送、06:
库存超期检定返回配送、07:
故障检测返回配送、08:
库存调拨、09:
监督抽检返回配送、99:
其它
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 系统 概要 设计 说明书