后台日志管理系统需求规格说明书1(精编文档).doc

【最新整理，下载后即可编辑】
后台日志管理系统
软件需求分析说明书V1.0
编制人：
编制日期：2011年8月10日
目录
1. 引言 (3)
1.1.编写目的 (3)
1.2.文档约定 (3)
1.3.预期读者和阅读建议 (4)
1.4.产品范围 (4)
2. 综合描述 (4)
2.1.产品的状况 (4)
2.2.产品的功能 (5)
2.3.运行环境 (7)
3. 外部接口需求 (8)
3.1.用户界面 (8)
3.2.硬件接口........................................................... 错误!未定义书签。

3.3.软件接口........................................................... 错误!未定义书签。

3.4.通讯接口 (8)
4. 系统功能需求 (11)
4.1.业务流程 (11)
4.1.1. 应用系统日志采集流程 (11)
4.1.2. 手机操作日志采集流程 (12)
4.1.3. 日志查询统计流程 (12)
4.1.4. 其他系统登陆日志采集 (13)
4.2.系统功能说明 (13)
4.2.1. 系统管理 (13)
4.2.2. MAS基础服务 (21)
4.2.3. 手机登陆日志 (22)
4.2.4. 系统应用日志 (24)
4.2.5. 平台操作日志 (24)
4.2.6. 应用日志统计 (29)
4.3.输入／输出数据............................................. 错误!未定义书签。

5. 其它非功能需求 ................................................. 错误!未定义书签。

5.1.性能需求........................................................... 错误!未定义书签。

5.2.业务规则........................................................... 错误!未定义书签。

6. 数据定义............................................................... 错误!未定义书签。

7. 分析模型............................................................... 错误!未定义书签。

1.引言
1.1.编写目的
本文旨在为MOA日志后台管理系统的设计开发提供一个明确的功能需求说明，用于定义、界定系统开发的功能范围，并且作为后续系统设计和开发的指引性文件，本文的主要阅读者是系统开发工程师、设计工程师及相关负责人。

本产品需求分析报告是为MOA日志后台管理系统软件产品编写的软件系统设计开发指引，说明开发这个软件产品意义、作用、以及最终要达到的意图。

通过这份软件产品需求分析报告详尽说明了该软件产品的需求规格，包括修正和(或)发行版本号，从而对该软件产品进行准确的定义。

1.2.文档约定
编写本文档时，正文文件的编写标准及各种排版约定遵循以下规则：
●正文风格：使用宋体，五号字；
●提示方式：使用批注提示；
●重要符号：使用“”符号，表明为重要提示信息；
1.3.预期读者和阅读建议
本需求的主要阅读者为系统的最终用户、开发人员、项目经理、测试人员及文档编写入员。

1.4.产品范围
MOA日志后台管理需求文档主要是提供一个日志统计分析和查询的系统，通过采集和监管相关系统发送的日志信息，分析业务系统的相干业务功能，实现业务的监管和操作跟踪。

2.综合描述
2.1.产品的状况
MOA日志后台管理系统需求是MOA系统为了方便管理和跟踪业务处理过程，并依据业务系统使用活动过程记录的信息，分析系统的使用情况、存在问题和对任意业务处理的过程追踪管理。

依据本软件的使用环境、特定用户要求，为MOA日志管理提供一个专用的日志分析工具。

本系统是MOA系统中的一员，是日志监管的基础和依据；
●本系统是依据客户特定要求，结合系统应用所新开发的一
款用于日志监管的业务系统；
●就目前从系统接受的资源来看，近阶段无相应的可以替代
的软件产品；
●新MOA日志后台管理系统是一款新型的、自主型的软件
产品。

●本系统是MOA软件产品的一个部分，用于分析日志记录，
并用过导出和清理功能，提供日志信息的查阅、维护管理
等功能。

●依据系统统计分析结果过，如何shiyong ？？怎么理解？
2.2.产品的功能
2.3.运行环境
本软件的运行环境，包括：
●硬件平台：
操作系统和版本：支持WindowsXP/Windows7/Linux
●支撑环境和版本：
支持IE6/IE7/IE8、360SE、Google、世界之窗、FirFox等浏览器；
数据库采用SQLServer 2005；
服务中间件支持Tomcat6、JBoss等；
●采用的相关组件
●与该软件共用的应用程序
工程项目名：mastudio
3.外部接口需求
MOA后台日志管理系统也需要采集外部应用系统的信息，所以后台日志系统与各个日志信息提供系统存在数据接口，另外后台日志管理系统本身也需要记录系统操作功能。

3.1.用户界面
3.2.通讯接口
●WEB浏览器；
IE6/IE7/IE8、360、Firfox等
●网络通讯标准或者协议；
手机与日志管理系统，采用SOCKET通讯；手机不直接和这个日志系统通讯的，手机只与我们的平台（MASTUDIO）；我们的平台通过HTTP协议将用户的操作按
指定格式提交。

●数据交互用电子表格
数据导出为EXCEL格式文件；
必须定义相关的：
●消息格式：
●
上图是我们mastudio服务器向日志系统post的一串字符
串，格式就是通过"&"符号链接，然后post到日志系统。

(recordForm这个应该是java里面定义的一个类吧, 纯属我
个人猜测），我们mastudio服务器最终post 的就是一串如
下面的字符串：
recordForm.id=&recordForm.oaName=11106015&recordFor
m.insertTiem=2011-8-13
15:31:55&recordForm.imei=1234567890123&recordForm.ip=1
92.168.1.1&recordForm.module=%E9%A6%96%E9%A1%B5
&recordForm.optype=%E7%99%BB%E5%BD%95&recordF
orm.opkey=%E7%99%BB%E5%BD%95&recordForm.opdesc =%E7%99%BB%E5%BD%95%E6%88%90%E5%8A%9F&r ecordForm.url=%2Fmas.mas"
字符说明：应用日志数据字段.xls
是否可以按照此方法做一个接口？
手机接口连接：IP地址和端口号；
传送日志格式为XML格式；
<Root>
<MOA_Log>
<time>yyyy/mm/dd hh:mm:ss</time>
<user>XXXXXX</user.>
<mid>XXXXXX</mid>
<sm>XXXXX</sm>
<pix>XXXX</pix>
<mac_id>XXXXXX</mac_id>
<function_no>XXXXXXX</function_no>
<op_type>XXXXX</op_type>
<op_stat>XX</op_stat>
<op_mem>XXXXXXXX</op_mem>
<url>XXXXXX</url>
</MOA_Log>
</Root>
●通讯安全或加密问题
目前日志采用明文方式传送；
●数据传输速率；
模块操作时，实时上传日志；
●同步和异步通讯机制
数据传送方式采用同步传送方式；
4.系统功能需求
该部分描述MOA日志后台管理系统的功能需求，本部分描述的是系统功能需求，作为系统界限的管理和维护。

4.1.业务流程
4.1.1.应用系统日志采集流程
4.1.2.手机操作日志采集流程
4.1.4.其他系统登陆日志采集
4.2.系
4.2.1.
4.2.1.1.
查看用户、修改用户、删除用户功能。

需求规格
1.新增用户
输入
姓名、职责、电话、紧急联系电话、手机号码、邮箱、工
号、帐户名称、帐户密码、角色、状态。

输出
用户管理主界面。

处理
①依据输入条件约束，进行数据合法性检查；
②在数据库中保存用户信息到相应分区中；
③转到用户管理主界面。

约束
①帐户名称必须唯一；
②角色只能是系统中定义的角色；
③状态只能是激活/冻结；
④员工姓名、员工职责、员工工号、帐户名称、帐户
密码、角色、状态非空；
参考界面
2.查询用户
输入
帐户名称、用户名称
输出
列表显示符合条件的用户信息。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③选定指定用户，可以查看显示用户的明细信息；
约束
无
参考界面
3.修改用户
输入
查询结果列表页面
输出
用户管理主界面。

处理
①获取选中的用户的信息；
②到数据库中查询该用户的详细信息；
③显示数据库返回的详细信息并转到用户信息修改页
面；
④用户对用户信息进行修改并提交；
⑤获取用户提交的用户信息数据；
⑥根据获取的数据对被修改的用户信息进行更新；
⑦转到用户管理主界面。

约束
①帐户名称必须唯一；
②角色只能是系统中定义的角色；
③状态只能是激活/冻结；
④员工姓名、员工职责、员工工号、帐户名称、帐户
密码、角色、状态非空；
4.删除用户
输入
查询结果列表页面
输出
用户管理主界面。

处理
①获取被选中的用户的信息；
②从数据库中删除该用户信息；
③转到用户管理主界面。

约束
无
4.2.1.2.角色信息管理
一、功能说明
在系统中可定义若干角色，每个具有不同的权限。

通过给用户赋予不同的角色，即可为多个用户授予系统的使用权限。

角色基本信息包括：角色名称、角色描述、权限（功能名称）。

包括新增角色，修改角色，删除角色，角色授权。

二、需求规格
1.新增角色
输入
角色编号、角色名称、权限编号、角色描述
输出
数据保存成功/失败
处理
①输入数据项的合法性验证；
②提交保存角色信息到数据库；
提示成功/失败信息；
约束（无）
2.角色修改
输入
角色名称、角色描述
输出
修改成功/失败
处理
①检索满足条件的角色信息，选定修该角色记录。

②进入角色编辑功能，变更角色基本信息。

③提交数据库保存变更后的角色信息。

3.角色授权
输入
用户名称、角色名称、授予的权限（功能模块）。

输出
授权成功/失败
处理
①检索角色基本信息，为指定角色添加用户；
②将角色与用户名称提交数据库保存。

4.2.1.3.功能菜单项管理
一、功能说明
在系统中可定义维护系统功能菜单项信息，通过设计菜单项将系统功能与菜单项建立映射关系。

通过给用户角色或用户赋予不同的功能菜单项，即可为多个用户授予系统的使用权限。

功能菜单项基本信息包括：功能编码、功能名称、功能描述、创建日期、创建人、最后修订日期、最后修订人员、可用状态。

该模块功能包括新增菜单项，修改菜单项，删除菜单项，菜单项查询。

二、需求规格
1.新增菜单项
输入
功能编码、功能名称、功能描述、创建日期、创建人、最
后修订日期、最后修订人员、可用状态。

输出
数据保存成功/失败
处理
①对输入数据项的合法性验证，日期包括时间；
②提交保存菜单项信息到数据库；
③在维护菜单项信息时，菜单可以树形方式展现。

提示成功/失败信息；
约束（无）
2.菜单项查询
输入
菜单项编码、菜单项名称
输出
列表显示符合条件的菜单项信息。

处理
④依据输入条件约束，进行数据合法性检查；
⑤列表显示数据库返回的信息。

⑥选定指定用户，可以查看显示用户的明细信息；
约束
4.2.2.MAS基础服务
一、功能说明
要求系统能够提供设计手机上传的IP接口服务信息设置，能够通过本接口接收发送的日志信息数据。

本模块提供启动、停止和监控日志接受服务。

二、需求规格
输入
无
输出
服务名称、服务状态。

处理
①选择基础服务，开启日志接收服务；
②选择停止服务，停止日志接受服务。

③实时监控日志服务的运行状态；
约束
无
界面参考
4.2.3.手机登陆日志
一、功能说明
要求系统能其他系统的登录日志文件，并能够打开文件分析信息发日志到日志数据库。

一般其他系统的文件格式是TXT格式文件。

日志系统要求能够读取指定服务器上的TXT 文件，并分析相关的文件内容，将信息保存到日志系统。

二、需求规格
1.接受日志文件
输入
文件名称、文件路径
输出
列表显示符合条件的手机登陆信息。

处理
④依据输入条件约束，进行数据合法性检查；
⑤列表显示数据库返回的信息。

⑥选定指定记录，可以查看显示手机登陆的明细信息；
约束
指定文件已经存在；
2.日志文件查询
输入
时间段、用户名、设备号、终端、服务器ip、操作模块、
操作类型、关键字、操作状态。

输出
列表显示符合条件的日志信息：时间、用户名、设备号、
终端、服务器ip、操作模块、操作类型、关键字、操作状
态。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③选定指定日志记录，可以查看日志的明细信息；
约束
3.登陆日志的统计分析
输入
时间段、用户名、设备号、终端、服务器ip、操作模块、
操作类型、关键字、操作状态。

输出
列表显示符合条件的日志信息，具体列表包括：列表显示
符合条件的日志信息：时间、用户名、设备号、终端、服
务器ip、操作模块、操作类型、关键字、操作状态。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③选定指定日志记录，可以查看手机登陆日志的明细
信息；
约束
4.2.4.系统应用日志
格式)
日志清除处理
4.2.
5.平台操作日志
一、功能说明
要求系统能够按照指定的要求统计本系统的操作日志信息，并依据日志的时间分类，按照时间可以分为按年、按月、按日、
按时间段统计本系统各个模块的操作日志信息。

并依据统计数据报表，可以生成统计报表、导出统计数据和报表服务。

二、需求规格
1.平台日志查询统计
输入
按日期段统计：选择起始、截止日期及统计方式、用户名、设备号、终端、服务器ip、操作模块、操作类型、操作状
态。

按年统计:选择要统计的年份及统计方式、用户名、设备号、终端、服务器ip、操作模块、操作类型、操作状态。

按月统计：选择要统计的年份、月份及统计方式、用户名、设备号、终端、服务器ip、操作模块、操作类型、操作状
态。

输出
按日期段统计：用户名，操作次数。

最后显示合计次数。

点击进入该用户的操作日志列表。

在日志列表，可查看详
情：包括“字段说明”中的所有字段。

按年统计、按月统计：操作次数。

点击进入操作日志列表。

在日志列表，可查看详情：包括“字段说明”中的所有字
段。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③选定指定日志记录，可以查看平台日志的明细信息；约束
无
参考界面
日志明细
2.平台日志报表导出
输入
按日期段统计：选择起始、截止日期及时间段、用户名、
设备号、终端、服务器ip、操作模块、操作类型、关键字、操作状态
输出
按日期段统计：用户名，操作次数。

最后显示合计次数。

点击进入该用户的操作日志列表。

在日志列表，可查看详
情：包括“字段说明”中的所有字段。

按年统计、按月统计：操作次数。

点击进入操作日志列表。

在日志列表，可查看详情：包括“字段说明”中的所有字
段。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③选定指定日志记录，可以查看平台日志的明细信息；
④将生成的统计日志信息，导出为指定文件名的
EXCEL文件；
约束
3.平台日志报表打印
输入
时间段、用户名、设备号、终端、服务器ip、操作模块、
操作类型、关键字、操作状态。

输出
列表显示符合条件的日志信息，具体列表包括：列表显示
符合条件的日志信息：时间、用户名、设备号、终端、服
务器ip、操作模块、操作类型、关键字、操作状态。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③打印平台日志统计报表；
约束
4.平台日志清除
输入
按日期段统计：选择起始、截止日期及时间段、用户名、
设备号、终端、服务器ip、操作模块、操作类型、关键字、操作状态
输出
按日期段统计：用户名，操作次数。

最后显示合计次数。

点击进入该用户的操作日志列表。

在日志列表，可查看详
情：包括“字段说明”中的所有字段。

按年统计、按月统计：操作次数。

点击进入操作日志列表。

在日志列表，可查看详情：包括“字段说明”中的所有字
段。

处理
①依据输入条件约束，进行数据合法性检查；
②列表显示数据库返回的信息。

③选定指定日志记录，提供清除日志记录；
④选择清除日志记录时，提供支持多选和全选方式；
约束
①系统指出单选日志、多选和全选功能；
4.2.6.应用日志统计
一、功能说明
要求系统能够按照指定的要求统计业务日志信息，并依据日志的时间分类，按照时间可以分为按年、按月、按日、按时间段统计应用系统（手机端系统）各个模块的操作日志信息。

并依据统计数据报表，可以生成统计报表、导出统计数据和报表服务。

二、需求规格
1.按月统计
输入
选择月份（所有的日志统计（不仅仅是应用日志统计），
如果选择按月统计，必须出现年份列表和月份列表）输出
①列表显示符合条件的应用日志统计信息。

②单月列表显示：日期、操作用户、系统使用次数、各个业务模块的操作次数。

处理
①依据输入条件约束，选定统计月份，进行数据合法
性检查；
②统计指定月份中每一日各个用户在系统中各个模块
的操作次数；
③列表显示数据库返回的信息。

④选定所有月份，可以查看的所有月份中各月每一日
的操作明细日志；
约束
①下拉选择月份时，除了从1-12个月份外，尚需要增加
“全部”，表示选择12个月；
②注意：是每个月的每一天（可能28天可能31天）；
界面参考
是选择月份的每一天的操作次数（如选择了2011年8月；
统计结果就是该月1号-31号的每一天的操作次数，然后点击1号，输出的结果是1号所有操作用户的操作次数（如下图），点击用户名，输出的结果是该用户在2011年8月1号的所有操作记录，然后点击该记录，可以查看该条记录的详细内容。

（每个页面需提供返回上一个页面的按钮）
2.按年统计
输入
选择年份，或年份时间段；
输出
①列表显示符合条件的应用日志统计信息。

②每一年12月列表显示：月份、操作用户、系统使用
次数、各个业务模块的操作次数。

是选择年份的每一个月的操作次数（如选择了2011年；统
计结果就是该年1月-12月的每一月的操作次数，如果点击1月，输出的结果是1月所有操作用户的操作次数（如下图），点击用户名，输出的结果是该用户在2011年1月的所有操作记录，然后点击该记录，可以查看该条记录的详细内容。

（每个页面需提供返回上一个页面的按钮）
处理
①依据输入条件约束，选定统计月份，进行数据合法性检查；
②统计指定年份中12个月各个用户在系统中各个模块的操作次数；
③列表显示数据库返回的信息。

④选定年份段，可以查看的各年中12个月份中各月操作
明细日志，如20110年至2011年每年12个月的操作信
息；
约束
①下拉选择年份时，除了从可选单个年份外，尚需要增
加年份段（即起始年份和终止年份，如：2010-2011年），
表示选择统计2010年到2011年各年12个月中业务操
作次数；
②选择查询指定月份记录，可以查看该月份的业务使用
次数；
界面参考。