管网监控系统设计说明书v1.docx
《管网监控系统设计说明书v1.docx》由会员分享，可在线阅读，更多相关《管网监控系统设计说明书v1.docx（54页珍藏版）》请在冰豆网上搜索。
管网监控系统设计说明书v1
案卷号
HL-08092301
日期
2008-09-23
＜管网监控系统＞
设计说明书
作者：
完成日期：
签收人：
签收日期：
修改情况记录：
版本号
修改批准人
修改人
安装日期
签收人
1引言
1.1编写目的
网络这个名词遍布我们生活的方方面面，平时我们比较熟悉的是互联网，现在我们讨论的是用水网络――自来水公司供水管网。
几乎所有的自来水公司都是通过集中取水，后静化、消毒、传送到每户居民家中。
水从一个地方流到另外一个地方需要两个条件：
1、〖管道〗是整个供水过程中的基础设施；2、〖压力〗水是只能从高处往低处流的，须保证足够的压力才能使水从水厂流到需要的地方。
铺设管道和维护管道正常运行都需要相当多的费用，怎样确保管道合理铺设，维护费用最少和水质的保证正是本系统诞生的初衷。
本设计说明书适用于系统开发者、测试者及系统的最终使用者。
主要供系统开发者及系统测试都使用。
1.2范围
本系统暂行命名为《管网监控系统》，版本号为1.0.0；
全系统由四部分组成：
£通讯服务系统：
用于与硬件交互，采集数据。
£通讯配置系统：
用于与硬件交互，配置硬件的工作参数。
£客户端查询管理系统：
用于人机交互，以图表、报表、列表等形式向用户展示数据。
£硬件系统：
主要指数据传输设备及仪表类数据采集设备。
通讯配置系统
（Java程序）
通讯服务系统
（windows服务）
各部分存在形式及与其他部分的关系如下图所示：
硬件系统
①②
③
客户端系统
（windows程序/
Java程序）
SQL数据库
④
1、通过通讯配置系统，设置硬件系统的工作参数；
2、由通讯服务系统，定时接收硬件系统传输过来的监控数据；
3、通讯服务系统将接收到的数据实时的存入SQL数据库中；
4、客户端系统通过调用数据库中的数据，以用户理解的各类形式展示。
1.3定义
基站：
也称数据记录仪，用来记录并监控接入的仪表的工作情况，并实时的将记录的数据传送到计算机。
其数据传送通过GSM号码，以短信SMS方式或GPRS方式传输。
通道：
指基站与仪表连接的部分，每一个通道能且只能接一个仪表，基站可以接入的仪表数量由基站所拥有的通道数决定。
流量计：
仪表的一种，用来监控和记录管道的流量信息。
压力仪：
仪表的一种，用来监控和记录管道的受压信息。
余氯仪：
仪表的一种，用来监控和记录管道的余氯信息。
浊度仪：
仪表的一种，用来监控和记录管道的浑浊度信息。
PH计：
仪表的一种，用来监控和记录管道的PH酸碱值。
水表：
仪表的一种，用来计量从安装开始到当前时间总共流过管道的水量。
1.4参考资料
杭州三科大表软件产品说明书
杭州三科供水大表监控分析系统v5.1.2
2项目概述
2.1产品描述
城市的管网包括自来水、煤气、电力网络，每种网络都存在一定的漏损问题，维护整个网络的正常运行，需要很高的费用。
为客户提供管网运行数据，帮助客户正确分析现状，随时随地了解供水管网的运行情况，是本软件的设计目标。
用户管理
2.2产品功能
设备管理
系统管理
系统帮助
管网监控系统
实时监控
数据报表
历史分析
【系统管理】……设定系统运行的参数
包括以下子模块：
『数据连接配置』、『系统参数设置』、『系统数据复位』、『数据安全管理』、『系统操作日志』。
【用户管理】……设定系统用户及其拥有的权限
包括以下子模块：
『角色管理』、『用户管理』、『密码修改』、『用户切换』。
【设备管理】……管理各类设备信息及设备安装信息
包括以下子模块：
『设备参数管理』、『设备建档管理』、『设备安装管理』、『设备维保管理』。
【实时监控】……以GIS、数据列表的形式显示各类设备当前监控信息
【历史分析】……以图表、数据表的形式显示各类设备历史监控信息
【数据报表】……以数据报表的形式显示各类设备的监控信息
【系统帮助】……用以系统的注册及系统的帮助
2.3用户特点
系统管理员：
拥有基本的数据库安装、操作能力；拥有基本的Windows操作系统下安装应用程序的能力；能熟练操作计算机。
普通用户：
能熟练操作计算机。
2.4一般约束
£通讯服务系统应以windows服务的形式存在，以保证每天24小时的不间断运行，开发语言使用C++，数据库使用SQLServer2000。
£通讯配置系统的开发语言使用Java，以B/S的架构形式存在。
£客户端查询管理系统B/S架构和C/S架构并存，开发语言分别使用Java和C#，数据库统一使用SQLServer2000。
£系统开发的控制采用VSS，以保证开发版本的一致。
£开发过程使用WBS分解树结构管理，细化到每一天每个人，以利于项目过程进度及质量的控制。
£通信协议部分的文档不在本设计说明书中赘述。
£系统拥有一定的预定义内容以帮助用户减少输入操作，所以预定义内容在系统中均不允许删除。
在系统中，预定义内容的标识由删除标识来标明，当删除标识的值=2，表明该记录内容为系统预定义内容。
当删除标识的值=1，表明当前有效记录。
删除标识的值=0，表明为已删除的记录。
2.5假设和依据
£本系统运行环境为Windows2000及以上、WindowsXP、WindowsServer2000及以上；
£本系统支持的数据库为SQLServer2000；
3功能详细设计
系统操作日志
数据安全管理
系统数据复位
系统参数设置
数据连接配置
3.1系统管理模块
UML并行图
3.1.1数据连接配置
1、功能简介
本功能用于显示本系统与主数据库之间的连接关系，以及设定本系统与归档数据库之间的连接关系。
2、详细功能
⑴、浏览主数据库连接信息：
系统与主数据库之间连接关系的设定由登录界面完成，采用开发工具自带的Config配置文件的方式，文件存储在系统运行目录下，本功能窗体仅显示与主数据库的连接信息。
⑵、设置归档数据库连接信息：
系统与归档数据库之间的连接关系，由本功能完成，采用数据存储的方式，存在系统参数表中。
3、数据表
归档数据库的连接信息存入系统参数表（SYS_Param_Tbl）中，系统参数表对应部分字段为：
SYS_Param_Tbl系统参数表
表名称：
系统参数表
英文名：
SYS_Param_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
……
目标PC
TargetServer
nvarchar
20
数据库名
TargetDb
nvarchar
20
用户名
TargetUser
nvarchar
20
密码
TargetPassword
nvarchar
20
●
端口号
TargetPort
nvarchar
10
●
……
4、限制约束条件
为了保证系统的正常运行，归档数据库的连接有且只有系统管理员可以进行操作，由系统管理员生成的任何角色的用户，均无权对其进行操作（但可以进入浏览）。
客户端与主数据库的连接由客户端用户在登录界面自行完成。
5、提示信息定义
对应操作
提示信息
设置归档数据库连接信息
请输入完整的数据库连接信息！
3.1.2系统参数设置
1、功能简介
本功能用来设置系统正常运行时需要使用到的各类基础数据。
主要涉及：
企业名称设定、报表主标题设定、数据单位信息设定、实时监控刷新频率的设定、初始密码设置、报废提前通知时间设定等。
2、详细功能
⑴、常规参数设置：
用来设置企业名称、报表主标题、实时监控刷新频率、区域最深维度、初始密码、报废提前通知时间、短信预警间隔时间等参数的值。
⑵、数据单位设置：
用来设置数据单位信息。
3、数据表
表名称：
系统参数表
英文名：
SYS_Param_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
企业名称
Company
nvarchar
100
●
报表主标题
Report_Title
nvarchar
50
●
刷新频率
Refresh
int
4
初始化密码
Init_Password
nvarchar
20
报废提前预警
Ahead
int
4
区域最深维度
Depth
int
4
短信预警间隔
Interval
int
4
……
表名称：
数据单位信息表
英文名：
SYS_Unit_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
单位名称
Unit_Name
nvarchar
10
√
4、限制约束条件
数据单位不允许出现重复且不允许修改，在删除数据单位时，应先判断数据单位是否已使用过，只有未被使用过的数据单位才允许删除，否则，报无法删除的提示信息；监控刷新频率只允许为整数；上述所有操作有且只有系统管理员可以进行操作，由系统管理员生成的任何角色的用户，均无权对其进行操作（但可以进入浏览）。
5、提示信息定义
对应操作
提示信息
设置参数信息
请输入完整的参数信息！
新增、修改数据单位信息
数据单位已存在，请确认后重输！
删除数据单位信息
确定要删除数据单位信息吗？
该数据单位已被其他数据引用，无法删除！
3.1.3系统数据复位
1、功能简介
本功能用于清理系统中所涉及到的相关数据表中已存在的数据记录。
2、详细功能
⑴、数据清理：
在数据库中的大部分数据表中，存在删除标志，系统中所做的删除操作，均以假删除为主（删除标志值设为0）；数据清理的功能就是将删除标志位值为0的数据从数据表中做物理删除。
从而实现释放数据库空间，保证数据库快速运行的功能。
⑵、数据复位：
数据复位的主要功能是除删除标志位值为2的预定义值外，将数据库中所有表的数据做真正的物理删除，使得数据库回到系统未使用时的状态。
3、数据表
本功能涉及到的数据表包括：
……
4、限制约束条件
上述操作仅系统管理员可以进行，由系统管理员生成的任何角色的用户，均无权对其进行操作（也不可以进入浏览）。
5、提示信息定义
对应操作
提示信息
数据清理
即将进行数据清理，执行本操作后清理的数据将无法恢复，是否继续？
数据复位
即将进行数据复位，执行本操作后复位的数据将无法恢复，是否继续？
3.1.4数据安全管理
1、功能简介
本功能用于实现对数据库（主数据库及归档数据库）和管理，主要功能包括数据备份、数据恢复和数据归档。
数据归档是指将主数据库中数据量较大的数据表中的数据，根据时间因子提取，存放到归档数据库中相对应的数据表中，以减轻主数据库的压力。
2、详细功能
⑴、数据备份：
用户在选择要备份的数据库后（主数据库或归档数据库），输入备份文件名称和备份路径后，执行数据备份操作。
⑵、数据恢复：
用户在选择要恢复的数据库后（主数据库或归档数据库），选择要执行恢复的相对应的备份文件，执行数据恢复操作。
⑶、数据归档：
用户在确定要归档数据的时间跨度后，执行数据的归档操作。
归档后，主数据库中该时间段内的数据被物理删除。
3、数据表
本功能涉及到的数据表包括：
……
4、限制约束条件
上述操作仅系统管理员可以进行，由系统管理员生成的任何角色的用户，均无权对其进行操作（也不可以进入浏览）。
5、提示信息定义
对应操作
提示信息
备份数据库
请输入备份文件名称！
恢复数据库
请选择要恢复的备份文件
备份文件与要恢复的数据库不匹配，请确认后重新选择！
归档数据库
归档开始日期不得晚于归档结束日期，请重新输入！
3.1.5系统操作日志
1、功能简介
本功能用于实现记录系统所有用户在系统中的各类操作，需要记录的操作有：
登录/退出系统、新增数据记录、修改数据记录，需向数据表中记录修改前的数据和修改后的数据、删除数据记录、查询数据记录、导出或打印数据记录等。
2、详细功能
⑴、初始进入本功能：
默认显示当日系统所有用户的所有操作。
⑵、查询操作日志：
查询条件包括查询起止日期、登录名称、角色名称、操作类型。
用户根据上述条件（可多条件查询），选择或输入相关信息后，可获取到相应的操作日志记录。
操作类型为系统预定义：
LogIn/LogOut（登录/登出）、UserData（用户/权限操作）、DataOperation（增/删/改操作）、QueryData（查询操作）、OtherOperation（导出/打印操作）。
⑶、删除操作日志：
用户选择某条操作日志后，通过功能按钮，可实现该记录的删除。
⑷、删除所有操作日志：
删除当前列表中显示的所有操作日志。
⑸、导出操作日志：
将当前列表中显示的所有操作日志以Excel表格的形式保存到本地电脑。
功能示例：
示例一：
新增用户
示例二：
修改区域信息
登录名称
Admin
登录名称
Lucy
操作时间
2008-9-2510:
35:
20
操作时间
2008-9-2515:
15:
10
操作类型
UserData
操作类型
DataOperation
操作描述
新增用户
操作描述
修改区域信息
操作条件
操作条件
操作前数据
操作前数据
Name：
常州四院
操作后数据
Role_Name：
普通用户；
Login_Name：
Lucy
操作后数据
Name：
常州第四人民医院
示例三：
查询操作日志
示例四：
导出仪表档案
登录名称
Admin
登录名称
Lucy
操作时间
2008-9-2511:
35:
20
操作时间
2008-9-2516:
15:
10
操作类型
QueryData
操作类型
OtherOperation
操作描述
查询操作日志
操作描述
导出仪表档案
操作条件
2008-9-1，2008-9-25，Lucy
操作条件
流量计，已启用
操作前数据
操作前数据
操作后数据
操作后数据
3、数据表
表名称：
操作日志表
英文名：
SYS_OperationLog_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
日志ID
Id
int
4
√
自增长
登录名称
Login_Name
nvarchar
20
操作时间
Log_Date
Date
8
操作类型
Log_Type
nvarchar
10
操作描述
Description
nvarchar
200
操作条件
Log_Condition
nvarchar
300
●
操作前数据
Log_Before
nvarchar
300
●
操作后数据
Log_After
nvarchar
300
●
4、限制约束条件
✓新增记录时，需向操作后数据中记录新增数据的重要内容，判断是否重要内容的标准为该内容能让系统管理员很容易的找到新增的具体记录；
✓修改记录时，需向操作前数据和操作后数据中记录相关记录的重要内容，判断是否重要内容的标准为该内容能让系统管理员很容易的找到修改后的详细记录，并能清楚的知道修改了什么内容；
✓删除记录时，批量删除记录，需在操作描述中记录是成批的删除数据，在操作条件中记录获取到这些要删除的记录的查询条件；单条记录删除，需在操作前数据中记录被删除记录的重要内容，判断是否重要内容的标准为该内容能体现出被删记录的主要含义；
✓操作条件内容为记录查询条件的值，多条件查询，中间以“，”分隔；
✓特别注意的是对操作日志的操作也需记录到操作日志表中，特别是删除日志的操作；
5、提示信息定义
对应操作
提示信息
删除操作
确定要删除操作日志信息吗？
查询操作
查询开始日期不得晚于查询结束日期，请重新输入！
客户管理
3.2用户管理模块
UML并行图
3.2.1角色管理
1、功能简介
本功能包含以下两部分内容：
角色定义及角色与模块间关系的设定。
系统预设系统管理员（角色名）一名，拥有本系统所有权限；其他角色信息由系统管理员自定义生成。
除系统管理员外，自定义生成的角色，在无其他表引用的情况下，均可以从系统中删除。
2、详细功能
⑴、新增角色：
输入角色名称和角色描述（角色描述可不输），经系统判断无角色名称重复后，新增成功。
⑵、修改角色：
选择要修改的角色记录，输入新的角色名称或角色描述（角色描述可不输），经系统判断与其他已存在的角色名称无重复后，修改成功。
与之关联的记录所显示的角色名称变成修改后的角色名称。
⑶、删除角色：
选择要删除的角色记录，经系统判断未被其他表所引用后，可以进行删除操作，否则系统应提示用户该角色记录已被相关记录引用。
⑷、角色权限设置：
选定角色信息后，该功能按钮高亮显示，点击该按钮，进入角色模块关联功能窗体，如果数据表中存在关联关系，则读取已有记录关在窗体中显示，如果无，则设定好角色模块关联信息后，存入数据表中。
在已存关联的情况下，采用先删除关联关系，再保存新关联关系的方法，实现角色与模块间关系的修改。
3、数据表
表名称：
角色信息表
英文名：
SYS_Role_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
角色编号
Id
int
4
√
自增长
角色名称
Role_Name
nvarchar
20
角色描述
Description
nvarchar
50
●
删除标识
Role_Flag
int
1
0=删除
表名称：
模块信息表
英文名：
SYS_Module_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
模块编号
Id
int
4
√
自增长
模块名称
Module_Name
nvarchar
20
表名称：
角色模块关系表
英文名：
SYS_Role_Module
数据名称
字段名称
类型
长度
主键
允许空
备注
角色编号
Role_Id
int
4
模块编号
Module_Id
int
4
4、限制约束条件
✓角色名称英文不能超过20个字母，中文不能超过10个汉字。
✓角色描述可以为空，但不为空的情况下，英文不能超过50个字母，中文不能超过25个汉字。
✓角色名称不能重复。
✓被引用的角色信息不允许随意删除。
5、提示信息定义
对应操作
提示信息
新增、修改角色操作
角色信息已存在，请在确认后重输！
删除角色操作
角色信息已被其他数据引用，删除失败！
确定要删除角色信息吗？
3.2.2用户管理
1、功能简介
系统预设系统管理员（登录名）一名，拥有本系统所有权限；由系统管理员定义其他用户，用户定义后，与角色相关联，可以拥有本系统的部分权限，用户的初始密码由系统管理员在系统参数表中定义。
2、详细功能
⑴、新增用户：
输入登录名称，经系统判断无登录名称重复后，新增成功。
⑵、修改用户：
选择要修改的用户记录，输入新的用户信息后，修改成功（登录名称不可以修改）。
⑶、删除用户：
选择要删除的用户记录，进行删除操作。
3、数据表
表名称：
用户信息表
英文名：
SYS_User_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
用户编号
Id
int
4
√
自增长
登录名称
Login_Name
nvarchar
20
所属角色
Role_Id
int
4
密码
Password
nvarchar
20
创建日期
Create_Date
Date
8
联系方式
Mobile
nvarchar
20
●
删除标识
User_Flag
int
1
0=删除
4、限制约束条件
✓登录名称英文不能超过20个字母，中文不能超过10个汉字。
✓登录名称不能重复。
5、提示信息定义
对应操作
提示信息
新增、修改用户操作
用户信息已存在，请在确认后重输！
删除用户操作
确定删除用户信息吗？
3.2.3客户管理
1、功能简介
本功能用来管理系统中涉及到的部分大客户的信息，并为这些大客户登录网页配置初始化的登录名和密码。
2、详细功能
⑴、新增客户信息：
输入客户信息，经系统判断无客户名称和登录名称重复后，新增成功。
⑵、修改客户信息：
选择要修改的客户记录，经系统判断无客户名称和登录名称重复后，修改成功。
⑶、删除客户信息：
选择要删除的客户记录，经系统判断未被其他数据表引用后，删除成功。
3、数据表
表名称：
客户信息表
英文名：
SYS_Customer_Tbl
数据名称
字段名称
类型
长度
主键
允许空
备注
客户编号
Id
int
4
√
自增长
客户全称
Customer
nvarchar
50
客户简称
Company
nvarchar
20
●
登录名
Login_Name
nvarchar
20
密码
Password
nvarchar
20
创建日期
Create_Date
Date
8
联系电话
Mobile
nvarchar
20
●
联系地址
Address
nvarchar
100
●
删除标识
Cust_Flag
int
1
0=删除
4、限制约束条件
✓客户名称英文不能超过50个字母，中文不能超过25个汉字。
✓登录名称英文不能超过20个字母，中文不能超过10个汉字。
✓客户名称、登录名称不能重复。
5、提示信息定义
对应操作
提示信息
新增、修改客户操作
客户信息已存在，请在确认后重输！
删除客户操作
确定删除客户信息吗？
客户信息已被其他数据引用，删除失败！
3.2.4密码修改
1、功能简介
本功能用于修改当前登录用户的密码。
2、详细功能
修改流程为：
输入旧密码→输入新密码→确认新密码→完成密码修改。
3、数据表
无。
4、限制约束条件
新旧密码不能为空，两次输入的新密码必须一致。
5、提示信息定义
对应操作
提示信息
密码修改
旧密码不正确，请在确认后重输！
新密码输入不一致，请在确认后重输！
3.2.5用户切换
1、功能简介
本功能用于快速回到
升级会员 