网关软件需求文档0620.docx
《网关软件需求文档0620.docx》由会员分享，可在线阅读，更多相关《网关软件需求文档0620.docx（16页珍藏版）》请在冰豆网上搜索。
网关软件需求文档0620
网关软件需求文档
1.引言
网络管理监控软件的网络部分的功能及设计说明，供网络管理软件调用。
1.1编写目的
本模块为联网中心网络管理监控件网络管理部分，本模块为实现网络管理监控软件的各网管功能提供接口及实现，通过对接口的规范，从而使网络管理软件通过调用即可实现各类网络监控。
1.2文档约定
●正文风格：
正文内容采用正常宋体5号字，小标题采用小四号黑体字，编号采用阿拉伯数字和小圆点来表示；
●提示方式：
暂无提示；
●重要符号：
重要符号会以红色下划线显示；编号以“.”来分隔
1.3产品范围
该模块为网关软件的获取网络设备方面的信息提供数据，以供设备管理人员随时监控网络设备性能以及各软件系统运行情况。
1.4参考文献
●C#网络应用案例导航，黄承安，2003年02月第一版，超星电子图书；
●SNMP协议入门，作者：
IT动力源，来源：
华为3Com，更新时间：
，网址：
/Hardware_Area/Doc_hw_3com/200411/3271.html；
2.综合描述
作用范围：
由联网中心的服务器连接的局域网内。
2.1产品的状况
网络管理软件产品的背景和起源：
●属于联网中心开发的自主型的产品。
●本软件系统与联网中心其他服务系统及应用系统存在基本的相互关系，通过局域网管理软件能够把联网中心大部分应用系统有效管理起来，包括软硬件设备，及各类信息数据都能得到有效的监控。
2.2产品的功能
产品功能包括：
2.2.1整体网络拓朴功能；
2.2.2远程主机监控功能；
2.2.3数据库性能监测功能；
2.2.4故障报警功能；
2.2.5业务数据监测功能；
2.2.6系统设置功能；
2.2.7流量统计分析功能；
2.2.8有效防止部分病毒功能；
2.2.9设备系统信息获取功能。
2.3用户类和特性
本软件系统由联网中心使用，但需要得到联网中心其他软件系统客户的配合，因为需要通过网络协议及接口管理和维护局域网内各客户的数据及计算机设备。
2.4运行环境
本软件的运行环境，包括：
●赛扬2.4GCPU，512M内存；
●操作系统和版本：
WindowsXP\2003\2000；
●支撑环境（例如：
数据库等）和版本：
Oralce、SQL-Server；
●其它与该软件有关的软件组件：
.netFrameWork1.1；
●与该软件共存的应用程序：
联网中心的其他类软件。
2.5设计和实现上的限制
设计实现上的限制：
●必须使用的特定技术、工具、编程语言和数据库：
C#、VisualStudio2003、Oralce、SQL-Server；（因为目前对这些工具比较熟）
●要求遵循的开发规范和标准：
要遵循ASN.1的编码标准；（要使用SNMP的指令获取MIB的信息就必须遵循ASN.1的编码标准）
●硬件的限制：
必须保证局域网的网络联通；（如果局域网都不能通的话，我们的系统也就检测不到任何一台主机，也就没有任何意义）
●数据转换格式标淮的限制（在SNMP协议中，发送数据包的时候，需要把标识符转换成十六进制，因为在网络中传送的都是二进制信息，相比十进制，十六进制和二进制转换更方便一些）。
2.6假设和约束（依赖）
列举出对软件产品需求分析报告中，影响需求陈述的假设因素（与己知因素相对立）。
如果这些假设因素不正确、不一致或者被修改，就会使软件产品开发项目受到影响。
这些假设的因素可能包括：
●将会使用一些免费的网络工具：
Ping工具：
负责检测网络是否畅通；
TraceRoute工具：
路由跟踪工具，对路由的结构进行跟踪，并返回相应信息；
FTP工具：
对局域网内的上传上下载进行管理等
●假定DBA管理员对Oracle非常熟练、假定系统管理员对网络各项协议有一些了解；
●有关本软件运行环境的一些问题：
假定我们能够自己搭建一个测试用的局域网，并假定测试用的局域网和真实的局域网性能一样；
此外，确定本软件开发项目对外部约束因素所存在的依赖。
有关的约束包括：
●人员约束：
假定局域网内受控设备的主体都同意我们的控制，其操作人员给予配合；
●设备约束：
受控局域网的总节点由我们全权控制，其受控设备均属于这个局域网，并且由当前总节点路由下传。
3.外部接口需求
本软件系统需要跟联网中心其他软件系统连接，以方便维护客户数据和系统。
包括：
售票系统、报表系统、结算系统、企业ERP业务、网上订票。
本软件系统将获取这些系统的部分数据，包括：
售票系统：
应用软件的版本信息、今日计划班次数、今日实际班次数、今日最大运量、今日出票量、今日检票量、目前班次计划的日期、执行计划的人员信息、执行日期、当前售票系统的客户端数、当前检票系统的客户端数、当天退票量；
报表系统：
需要监测的数据包括报表的数量及名称、中间数据转换是否成功、是否人工转换、转换人员、转换时间、当前连接报表服务器的IP地址、查看人员；
结算系统：
当前从售票系统转入结算系统的信息（截止日期、结算信息、执行人、执行时间）、目前结算的周期、参与结算的单位数、参与结算的车辆数、当前已结算的结算单数、尚未结算的结算单数、失效的结算单数；
企业ERP系统：
留一个接口作为以后扩展用。
网上订票系统：
网站的注册会员数、日最大访问量、日平均访问量、当前在线人数、当日在线订票量、当日在线购票量、当日在线交易成功数、当日在线交易失败数、当日在线交易成功率。
3.1硬件接口
本产品与系统硬件接口包括：
●支持的硬件类型：
路由器、带地址的交换机、主机；
●软件和硬件之间交流的数据最主要是通过网际传输的PDU包，PDU包包括了局域网内各硬件设备之间传输的协议及数据，数据包括硬件本身信息、运行信息及各软件系统、进程的运行信息；
●使用的通讯协议：
TCP\IP协议、UDP协议、SNMP协议、ICMP协议；
3.2软件接口
外部组件包括：
●操作系统：
WindowsXP\2000\2003、Linux；
●数据库：
Oracle（目前仅使用Oracle）；
●工具：
Ping工具、TraceRoute、FTP工具；
●集成的商业组件：
.netFrameWork1.1、Tomat服务程序、Oracle服务程序、SNMP服务程序、异地售票服务、FTP服务等；
3.3通讯接口
描述与软件产品所使用的通讯功能相关的需求，包括：
●电子邮件：
因为需要使用自动发送电子邮件，所以需要支持SMTP协议；
电子邮件是在预警时候使用的，发送格式为：
XXX：
（接收邮件的用户名）
现（设备名称）发生（故障内容），请你尽快处理解决。
设备名称和故障内容由我们的软件系统获取。
●WEB浏览器：
服务器端采用IIS服务器，客户端使用IE浏览器进行访问；
●网络通讯标准或者协议：
TCP/IP、UDP、SNMP、ICMP、SMTP协议；
4.系统功能需求
相关的详细功能需求
4.1用户权限需求
详细描述使用该系统的各个用户的分类及可以访问的资源等信息
4.1.1权限模块设置
1.网络连接模块：
包括IP地址、MAC地址、网络流量的查询监控；
2.服务器运行模块：
包括CPU、硬盘、内存、系统运行时间；
3.关键服务程序模块：
Oracle服务，Tomcat服务，IIS服务，异地售票服务，双机服务，短信订票服务，网上订票服务；
4.路由访问设置模块：
通过路由的进出流量、地址转换列表、端口信息；
5.数据库关键信息模块：
表空间、连接数、进程数、当前游标数、归档文件、日志文件、控制文件、数据文件；
6.关键业务模块：
售票系统，结算系统，报表系统，大小屏接口数据，语音系统接口数据等；
7.数据库系统表模块：
数据库进程数、进程名称、数据库会话数、会话对象、数据库表空间及文件路径（已使用，未使用，使用百分比）、数据库的对象名的大小及状态（对象名包括表、存储过程、包、函数、索引、序列等，失效状态）、监控表空间的I/O比例、表和索引的存储检查、日志文件的大小与路径、作业进程的状态（Job）下次执行时间，执行的频率；
8.用户管理模块：
负责用户的增加，角色设置。
4.1.2角色管理
1.普通管理员：
具有对网络连接模块、服务器运行模块、关键服务程序模块的权限；
2.系统管理员：
具有对网络连接模块、服务器运行模块、关键服务程序模块、路由访问设置模块、数据库关键信息模块、关键业务模块、用户管理模块的权限；
3.DBA管理员：
具有对网络连接模块、服务器运行模块、关键服务程序模块、路由访问设置模块、数据库关键信息模块、关键业务模块、数据库系统表模块的权限。
4.1.3用户设置
4.2网络需求
针对不同的路由器、服务器等网络设备分别进行如下内容的描述。
同时描述针对不同的前提条件，能够获取不同的信息内容.
4.2.1网络设备的分类：
路由器、带地址的交换机、PC电脑；
4.2.2采用的网络协议：
SNMP协议、TCP\IP协议
4.2.3获取信息的前提条件：
网路通畅及各协议已经安装完的前提下（包括SNMP协议）。
4.2.4获取信息的手段：
通过SNMP协议发送接收MIB包，再解析MIB包。
4.2.5获取的信息内容
1.详细流量分析
2.通讯端口信息
3.网络是否畅通
4.IP地址绑定
5.远程截屏
6.PC进程清单
8.设备类型名称
9.设备正常运行时间
10.PC安装文件清单
11.应用程序使用控制
12.远程登录
13.设备的CPU、内存
14.网络慢的原因
15.监测伪造的IP
16.监测整体网宽占用率
17.监测每个节点网络带宽利用率
18.网络数据包大小分布
19.安全漏洞检测
20.查看TCP数据流
21.IP的物理位置
22.根据域名获取IP
23.数据包解码
24.网络流量利用率
4.2.6获取的信息内容的存储方式
存储方式分为两种：
1.日志方式存储：
故障内信息采取日志方式存储
2.数据库存储：
需要一直保存及分析的数据采取数据库存储
4.2.7获取的信息内容的显示手段
显示方式分为：
1.报表方式显示：
这种显示方式是所有信息通用的显示方式。
2.柱形图方式显示：
是历史流量使用的显示方式。
3.曲线图显示：
分析流量数据时使用。
4.拓朴图显示：
最主要是对局域网的网络结构进行描述。
4.2.8获取信息的频率
获取信息的频率根据实时设置，默认为5分钟轮循一次，时间单位为分钟。
4.3操作系统需求
按照不同的操作系统分别进行以下内容的描述。
同时描述针对不同的前提条件，能够获取的信息内容
4.3.1操作系统分类：
Windows、Linux；
4.3.2获取系统信息的前提条件：
网络必须通畅，并且受控设备需要从服务器所管理的路由器连接出去；
当网络不畅通的时候，本软件处于无效状态；
如果需要控制的设备不是从服务器管理的路由连接的，本系统将搜索不到此设备。
4.3.3获取信息的手段：
1.通过下载的工具获取；
2.通过自己编写SNMP的操作类获取。
4.3.4获取的信息内容分类：
1.操作系统版本
2.运行时间
3.当前运行进程
4.当前用户
5.标识
6.用户状态
7.联网信息
8.CPU使用率
9.内存使用率
10.总数（名柄数、线程数、进程数）
11.物理内存（总数、可用数、系统缓存）
12.认可用量（总数、限制、峰值）
13.核心内存（总数、分页数、未分页）
4.3.5获取的信息内容的存储方式：
根据用户设置，采取两种存储方式
1.数据库表格存储方式
2.日志存储方式
4.3.6获取的信息内容的显示手段
1.报表显示方式：
根据设置显示需要的字段
2.柱形图显示：
最主要是针对性能分类信息类显示
3.曲线图显示：
针对不同时段类的信息进行比较显示
4.3.7获取信息的频率
获取信息的频率根据用户需要进行调节，最小单位为分钟，建议不要使用太频繁，而额外增加系统负担及网络负担，每小时一次较佳。
意外情况可手动进行捕获。
4.4数据库系统需求
获取不同的数据库的运行状态等信息
数据库软件名称：
Oracle、SQL-Server、DB2、MySQL；
4.4.1数据库软件运行的操作系统：
Windows、Linux；
4.4.2获取信息的方式
1.Oracle的数据可以通过Oracle专业工具获得；
2.可以通过截取传送的数据包进行解协获取。
4.4.3获取数据库的相关监控内容
1.数据库进程
2.数据库连接数（会话）
3.数据库文件的大小及路径
4.表空间大小及使用率、剩余空间
5.日志文件的大小及路径
6.当前锁的信息
7.当前会滚段信息
8.当前Job的状态
9.数据库对象名称及状态
10.数据库分区状态
4.4.4获取的信息内容的存储方式
使用数据库存储
4.4.5获取的信息内容的显示手段
显示手段采用表格方式显示，需要显示的字段可根据用户设置进行显示和隐藏。
4.4.6获取信息的频率
获取信息的频率建议不要太高，避免造成数据库性能的下降，每天一次比较合适。
4.5应用软件需求
不同的应用软件，获取的信息的方式不一样，能够获取的信息也不一样。
4.5.1应用软件名称：
1.售票系统
2.报表系统
3.结算系统
4.网上订票
4.5.2应用软件运行的环境
1.售票系统为Windows下的C/S程序，其中数据库为Linux下面的Oracle；
2.报表系统为Windows下的C/S程序，其中数据库为Linux下面的Oracle；
3.结算系统为Windows下的C/S程序，其中数据库为Linux下面的Oracle；
4.网上订票为Windows的B/S程序，服务器为IIS，数据库为Linux下面的Oracle。
4.5.3是否需要应用软件进行额外的开发，以支持网关软件的要求
正常情况下不需要考虑应用软件开发，因为相关信息都从数据库中获取，但如果对一些意外的数据需要作记录的话需要在应用软件中设置意外情况发送标志给网关软件。
4.5.4支持的获取的方式或手段
获取数据需要知道数据库的用户名和密码，通过专业的数据库工具进行获取。
4.5.5获取的内容
1.售票系统：
应用软件的版本信息
今日计划班次数
今日实际班次数
今日最大运量
今日出票量
今日检票量
目前班次计划的日期
执行计划的人员信息
执行日期
当前售票系统的客户端数
当前检票系统的客户端数
当天退票量；
2.报表系统
需要监测的数据包括报表的数量及名称
中间数据转换是否成功
是否人工转换
转换人员
转换时间
当前连接报表服务器的IP地址
查看人员；
3.结算系统
当前从售票系统转入结算系统的信息：
截止日期、结算信息、执行人、执行时间
目前结算的周期
参与结算的单位数
参与结算的车辆数
当前已结算的结算单数
尚未结算的结算单数
失效的结算单数；
4.网上订票
网站的注册会员数
日最大访问量
日平均访问量
当前在线人数
当日在线订票量
当日在线购票量
当日在线交易成功数
当日在线交易失败数
当日在线交易成功率。
4.5.6获取的信息内容的存储方式：
采用数据库存储
4.5.7获取的信息内容的显示手段
1.某一时间的采取表格显示
2.某一段时间的采取图表方式显示
4.5.8获取信息的频率
频率不宜太频繁，避免增加数据库的负担，建议一天一次，这样可以对数据进行比较。
4.6特殊设备需求
4.6.1特殊设备的分类：
双机热备份系统、集群系统
4.6.2获取信息的前提：
设备均在网络内，并且具有可访问的IP
4.6.3获取信息的方式：
通过网络协议进行访问
4.6.4获取的内容：
1.主机运行状态（IP地址，数据库状态、操作系统状态）
2.备机运行状态（IP地址，数据库状态、操作系统状态）
3.集群服务器状态：
各服务器的运行状态
4.6.5获取的信息内容的存储方式
当运行正常时采取数据库记录，发生异常同时保存在本地以及发送警报标志，这样避免网络故障异常造成的无法准备监测设备。
4.6.6获取的信息内容的显示手段：
使用表格显示方案。
4.6.7获取信息的频率：
当设备处于运行比较稳定的状态下，可一天一次，如果有一些异常可根据需要进行实时设置，以解决异常问题。
4.7预警需求
4.7.1预警的种类：
硬件预警：
指CPU利用率、内存使用率，剩余空间、硬盘使用率
软件预警：
设置的服务程序是否正在运行，例如：
Oracle服务程序，SNMP服务程序、FTP服务，异地售票服务，Tomcat服务等。
网络预警：
网络故障报警主要是监测到网络连通时，能否通过这个网络设备，若不能通过网络设备则显示该网络设备存在故障。
同时也监测一些通过网络设备的数据包，其中包括数据包的大小及数量，当这些数据包超过一定的值后，同样也显示报警状态。
数据库报警：
主要显示在数据库中的关键的值达到了预先设定的报警的值，这些报警的值包括：
数据库关键进程状态、数据库连接数、表空间使用率、日志文件大小等，当这些值达到一定的值后，就会产生报警信号，通过不同的方式通知系统管理员。
同时在界面上也有相应的显示。
4.7.2预警等级分类：
可以由用户设置，系统默认设置三类：
灾难性报警（指网络瘫痪或者服务器瘫痪类故障报警）、紧急报警（服务器重启或者关键服务程序中止类故障）、一般预警（性能问题、流量过大问题）。
4.7.3预警传送的方式：
方式分为三种，Email方式，手机短信方式，页面弹出。
4.7.4预警的阀值设定：
由系统管理员设定。
4.7.5预警信息的存储：
预警信息采用日志存储方式。
4.8统计需求
4.8.1报表的分类
1.流量统计类报表
2.业务数据统计报表
3.局域网内设备统计报表
4.故障类统计报表
5.数据库类性能统计报表
6.操作系统类统计报表
4.8.2形成的报表列表
1.每台设备的历史流量报表
2.售票系统业务数据统计报表
3.结算系统业务数据统计报表
4.报表系统业务数据统计报表
5.网上订票业务数据统计报表
6.网络结构设备统计报表
7.设备性能异常统计报表
8.预警报表
9.数据库性能报表
10.操作系统信息报表
5.其它非功能需求
5.1性能需求
阐述不同应用领域对软件产品性能的需求，并且说明提出需求的原理或者依据，以帮助开发人员做出合理的设计选择。
尽可能详细地描述性能需求，如果需要，可以针对每个功能需求或者特征分别陈述其性能需求。
在这里确定：
●相互合作的用户数量；
●系统支持的并发操作数量；
●响应时间；
●与实时系统的时间关系：
●容量需求
⏹存储器；
⏹磁盘空间；
⏹数据库中表的最大行数。
5.2安全措施需求
详尽陈述与软件产品使用过程中可能发生的损失、破坏、危害相关的需求。
定义必须采取的安全保护或动作，以及必须预防的潜在危险动作。
明确软件产品必须遵从的安全标准、策略、或规则。
5.3安全性需求
详尽陈述与系统安全性、完整性问题相关的需求，或者与个人隐私问题相关的需求。
这些问题将会影响到软件产品的使用，和软件产品所创建或者使用的数据的保护。
定义用户身份认证，或备授权需求。
明确软件产品必须满足的安全性或者保密性策略。
也可以通过称为完整性的质量属性来阐述这些需求。
一个典型的软件系统安全需求范例如下：
“每个用户在第一次登录后，必须更改他的系统预置登录密码，系统预置的登录密码不能重用。
”
5.4软件质量属性
详尽陈述对客户和开发人员至关重要的在软件产品其它方面表现出来的质量功能。
这些功能必须是确定的、定量的、在需要时是可以验证的。
至少也应该指明不同属性的相对侧重点，例如：
易用性优于易学性，或者可移植性优于有效性。
5.5业务规则
列举出有关软件产品的所有操作规则，例如：
那些人在特定环境下可以进行何种操作。
这些本身不是功能需求，但是他们可以暗示某些功能需求执行这些规则。
一个业务规则的范例如下：
“进行达到或者超过10，000，00元人民币的储蓄业务时，必须通过附加的管理员认证。
”
列举业务规则时，可以根据规则的数量，选取合适的编目方式。
6.数据定义
数据定义是一个定义了应用程序中使用的所有数据元素和结构的共享文档，其中对每个数据元素和结构都准确描述了：
含义、类型、数据大小、格式、计量单位、精度以及取值范围。
数据定义的维护独立于软件需求规格说明，并且在软件产品开发和维护的任何阶段，均向所省风险承担者开放。
如果为软件开发项目创建一个独立的数据定义，而不是为每一项特性描述有关的数据项，有利于避免冗余和不一致性。
但是却不利于多人协同编写需求分析报告，容易遗漏数据，也不方便阅读。
因此还是建议为每个特性描述有关的数据项，汇总数据项创建数据定义，再根据数据定义复核全部数据，使得它们的名称和含义完全一致。
必须注意的是，为了避免二义性，在汇总数据项时应该根据数据项所代表的实际意义汇总，而不是根据数据项的名称汇总。
在数据定义中，每个数据项除了有一个中文名称外，还应该为它取一个简短的英文名称，该英文名称应该符合命名规范，因为在软件开发时将沿用该英文名称。
可以使用等号表示数据项，名称写在左边，定义写在右边。
常见数据项的描述方式如下：
●原数据元素
一个原数据元素是不可分解的，可以将一个数量值赋给它。
定义原数据元素必须确定其
含义、类型、数据大小、格式、计量单位、精度以及取值范围。
采用以星号为界的一行
注释文本，描述原数据元素的定义。
●选择项
选择项是一种只可以取有限离散值的特殊原数据元素，描述时一一枚举这些值，并用方
括号括起来写在原数据元素的定义前。
在两项离散值之间，使用管道符分隔。
●组合项
组合项是一个数据结构或者记录，其中包含了多个数据项。
这些数据项可以是原数据元
素，也可以是组合数据项，各数据项之间用加号连接。
其中每个数据项都必须是数据定
义中定义过的，结构中也可以包括其它结构，但是绝对不允许递归。
如果数据结构中有
可选项，使用圆括号把该项括起来。
●重复项
重复项是组合项的一种特例，其中有一项将有多个实例出现在数据结构中，使用花括号
把该项括起来。
如果知道该项可能允许的范围，就按“最小值：
最大值”的形式写在花
括号前。
7.分析模型
这是一个可选部分，包括或涉及到相关的分析模型，例如：
●数据流程图；
●类图；
●状态转换图；
●实体-关系图。
8.待定问题列表
编辑一张在软件产品需求分析报告中待确定问题时的列表，把每一个表项都编上号，以便跟踪调查。
升级会员 