1、第-1- 页后 台 日 志 管 理 系 统软件需求分析说明书 V1.0编 制 人： 编制日期：2011 年 8 月 10 日 第-2- 页目录1. 引言 .31.1. 编写目的 .31.2. 文档约定 .31.3. 预期读者和阅读建议 .31.4. 产品范围 .32. 综合描述 .42.1. 产品的状况 .42.2. 产品的功能 .42.3. 运行环境 .53. 外部接口需求 .63.1. 用户界面 .63.2. 硬件接口 .63.3. 软件接口 .63.4. 通讯接口 .74. 系统功能需求 .74.1. 业务流程 .84.1.1. 应用系统日志采集流程 .84.1.2. 手机操作日志采集流
2、程 .84.1.3. 日志查询统计流程 .94.1.4. 其他系统登陆日志采集 .94.2. 系统功能说明 .104.2.1. 系统管理 .104.2.2. MAS 基础服务 104.2.3. 手机登陆日志 .104.2.4. 系统应用日志 .104.2.5. 平台操作日志 .114.2.6. 应用日志统计 .114.3. 输入输出数据 .115. 其它非功能需求 .115.1. 性能需求 .115.2. 业务规则 .126. 数据定义 .127. 分析模型 .12第-3- 页1. 引言1.1. 编写目的本文旨在为 MOA 日志后台管理系统的设计开发提供一个明确的功能需求说明，用于定义、界定系
3、统开发的功能范围，并且作为后续系统设计和开发的指引性文件，本文的主要阅读者是系统开发工程师、设计工程师及相关负责人。本产品需求分析报告是为 MOA 日志后台管理系统软件产品编写的软件系统设计开发指引，说明开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件产品需求分析报告详尽说明了该软件产品的需求规格，包括修正和( 或) 发行版本号，从而对该软件产品进行准确的定义。1.2. 文档约定编写本文档时，正文文件的编写标准及各种排版约定遵循以下规则： 正文风格： 使用宋体，五号字； 提示方式： 使用批注提示； 重要符号： 使用“”符号，表明为重要提示信息；1.3. 预期读者和阅读建议本需求的
4、主要阅读者为系统的最终用户、开发人员、项目经理、测试人员及文档编写入员。1.4. 产品范围MOA 日志后台管理需求文档主要是提供一个日志统计分析和查询的系统，通过采集和监管相关系统发送的日志信息，分析业务系统的相干业务功能，实现业务的监管和操作跟踪。第-4- 页2. 综合描述2.1. 产品的状况MOA 日志后台管理系统需求是 MOA 系统为了方便管理和跟踪业务处理过程，并依据业务系统使用活动过程记录的信息，分析系统的使用情况、存在问题和对任意业务处理的过程追踪管理。依据本软件的使用环境、特定用户要求，为 MOA 日志管理提供一个专用的日志分析工具。 本系统是 MOA 系统中的一员，是日志监管的
5、基础和依据； 本系统是依据客户特定要求，结合系统应用所新开发的一款用于日志监管的业务系统； 就目前从系统接受的资源来看，近阶段无相应的可以替代的软件产品； 新 MOA 日志后台管理系统是一款新型的、自主型的软件产品。 本系统是 MOA 软件产品的一个部分，用于分析日志记录，并用过导出和清理功能，提供日志信息的查阅、维护管理等功能。 依据系统统计分析结果过，如何 shiyong ？怎么理解？2.2. 产品的功能项目号： 项目名称：MOA 日志后台管理系统项目经理（售前责任人） 日期2011/8/11业务功能需求编号业务功能需求名称子功能需求编号子功能需求名称 简要说明系统说明：利用各种日志信息的
6、采集方式，采用符合业务要求的分析方法，通过对采集的原始日志数据进行分析，以便能够跟踪和监管系统的运行情况，实现系统功能的拓展和性能的优化。A001 功能信息管理A002 用户信息管理A003 分组/部门管理A004 角色管理A005 权限分配A、 系统管理A006 密码修改第-5- 页B001 MAS 服务管理B002 黑名单B、 MAS 基础服务B003 白名单C001 日志文件接收C、 手机登陆日志C002 日志查询D、 系统应用日志 D001 日志查询 提供系统应用模块操作日志的采集、分类、查询及清理。C、 平台操作日志 C001 日志查询 提供本日志管理系统相关模块操作日志的采集、分类
7、、查询及清理。F001 时间段统计表 按年、季度、月分、时间段分类统计系统应用模块操作日志信息，提供统计、导出、打印及清理。最后显示合计次数。点击进入该用户的操作日志列表。在日志列表，可查看详情：包括“字段说明”中的所有字段。F002 人员分类统计 按统计方式、用户名、设备号、终端、服务器 ip、操作模块、操作类型、操作状态等条件统计某一时间段的应用系统模块操作日志信息，提供日志统计报表的生成、导出、打印及清理。F003 导出日志信息 按时间段、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态为条件，检索统计日志并导出 EXCEL 文件。F、 应用日志统计F004 日志
8、清理 可设置清除日志的代理运行的时间（默认为凌晨 3:00）；根据设置，自动定时清除日志。2.3. 运行环境本软件的运行环境，包括： 硬件平台：操作系统和版本：支持 WindowsXP/Windows7/Linux 支撑环境和版本：支持 IE6/IE7/IE8、360SE、Google、世界之窗、FirFox 等浏览器；数据库采用 SQLServer 2005；服务中间件支持 Tomcat6、JBoss 等； 采用的相关组件 与该软件共用的应用程序第-6- 页工程项目名：mastudio3. 外部接口需求MOA 后台日志管理系统也需要采集外部应用系统的信息，所以后台日志系统与各个日志信息提供系
9、统存在数据接口，另外后台日志管理系统本身也需要记录系统操作功能。3.1. 用户界面3.2. 通讯接口 WEB 浏览器；IE6/IE7/IE8、360、Firfox 等 网络通讯标准或者协议；手机与日志管理系统，采用 SOCKET 通讯；？手机不直接和这个日志系统通讯的，手机只与我们的平台（MASTUDIO ） ；我们的平台通过 HTTP 协议将用户的操作按指定格式提交。 数据交互用电子表格数据导出为 EXCEL 格式文件；必须定义相关的： 消息格式：第-7- 页上图是我们 mastudio 服务器向日志系统 post 的一串字符串，格式就是通过“&“符号链接，然后 post 到日志系统。 (r
10、ecordForm 这个应该是 java 里面定义的一个类吧, 纯属我个人猜测） ，我们 mastudio 服务器最终 post 的就是一串如下面的字符串：recordForm.id=&recordForm.oaName=11106015&recordForm.insertTiem=2011-8-13 15:31:55&recordForm.imei=1234567890123&recordForm.ip=192.168.1.1&recordForm.module=%E9%A6%96%E9%A1%B5&recordForm.optype=%E7%99%BB%E5%BD%95&recordFor
11、m.opkey=%E7%99%BB%E5%BD%95&recordForm.opdesc=%E7%99%BB%E5%BD%95%E6%88%90%E5%8A%9F&recordForm.url=%2Fmas.mas“字符说明：应用日志数据字段.xls是否可以按照此方法做一个接口？手机接口连接：IP 地址和端口号；传送日志格式为 XML 格式；yyyy/mm/dd hh:mm:ssXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX第-8- 页XXXXXXXXXXXXXXXXXXXXX 通讯安全或加密问题目前日志采用明文方式传送； 数据传输速率；模块操作时，实时上传日志； 同步和
12、异步通讯机制数据传送方式采用同步传送方式；4. 系统功能需求该部分描述 MOA 日志后台管理系统的功能需求，本部分描述的是系统功能需求，作为系统界限的管理和维护。4.1.业务流程4.1.1. 应用系统日志采集流程业业业业业业MOA他他他他第-9- 页4.1.2. 手机操作日志采集流程业业业 业业业业业业业 业业业业 业业业MOA他他他他他他4.1.3. 日志查询统计流程业业业业业20业业业 业业业业业业业EXCEL业业业业业业业业业MOA他他他他第-10- 页4.1.4. 其他系统登陆日志采集业业/业 业业业 业业业MOA他他他他他他4.2.系统功能说明4.2.1. 系统管理业业业(from
13、Use Case View)业业业业业业业业业业业业业业参照上图，系统管理主要维护管理系统的用户信息及权限管理，主要包括用户信息管理、角色管理、密码管理、权限管理、密码修改功能。4.2.1.1.用户管理 功能描述对系统的所有用户进行管理，提供新建用户、查询用户、查看用户、修改用户、删除用户功能。 需求规格1. 新增用户输入第-11- 页姓名、职责、电话、紧急联系电话、手机号码、邮箱、工号、帐户名称、帐户密码、角色、状态。输出用户管理主界面。处理1 依据输入条件约束，进行数据合法性检查；2 在数据库中保存用户信息到相应分区中；3 转到用户管理主界面。约束1 帐户名称必须唯一；2 角色只能是系统中
14、定义的角色；3 状态只能是激活/冻结；4 员工姓名、员工职责、员工工号、帐户名称、帐户密码、角色、状态非空；参考界面2. 查询用户输入帐户名称、用户名称输出列表显示符合条件的用户信息。处理第-12- 页1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 选定指定用户，可以查看显示用户的明细信息；约束无参考界面3. 修改用户输入查询结果列表页面输出用户管理主界面。处理1 获取选中的用户的信息；2 到数据库中查询该用户的详细信息；3 显示数据库返回的详细信息并转到用户信息修改页面；4 用户对用户信息进行修改并提交；5 获取用户提交的用户信息数据；6 根据获取的数据对被修改的
15、用户信息进行更新；7 转到用户管理主界面。第-13- 页约束1 帐户名称必须唯一；2 角色只能是系统中定义的角色；3 状态只能是激活/冻结；4 员工姓名、员工职责、员工工号、帐户名称、帐户密码、角色、状态非空；4. 删除用户输入查询结果列表页面输出用户管理主界面。处理1 获取被选中的用户的信息；2 从数据库中删除该用户信息；3 转到用户管理主界面。约束无4.2.1.2.角色信息管理1、功能说明在系统中可定义若干角色，每个具有不同的权限。通过给用户赋予不同的角色，即可为多个用户授予系统的使用权限。角色基本信息包括：角色名称、角色描述、权限（功能名称） 。包括新增角色，修改角色，删除角色，角色授权
16、。2、需求规格1. 新增角色输入角色编号、角色名称、权限编号、角色描述输出数据保存成功/失败处理1 输入数据项的合法性验证；第-14- 页2 提交保存角色信息到数据库；提示成功/失败信息；约束（无）2. 角色修改输入角色名称、角色描述输出修改成功/失败处理1 检索满足条件的角色信息，选定修该角色记录。2 进入角色编辑功能，变更角色基本信息。3 提交数据库保存变更后的角色信息。3. 角色授权 输入用户名称、角色名称、授予的权限（功能模块） 。输出授权成功/失败处理1 检索角色基本信息，为指定角色添加用户；2 将角色与用户名称提交数据库保存。4.2.1.3.功能菜单项管理1、功能说明在系统中可定义
17、维护系统功能菜单项信息，通过设计菜单项将系统功能与菜单项建立映射关系。通过给用户角色或用户赋予不同的功能菜单项，即可为多个用户授予系统的使用权限。功能菜单项基本信息包括：功能编码、功能名称、功能描述、创建日期、创建人、最后修订日期、最后修订人员、可用状态。该模块功能包括新增菜单项，修改菜单项，删除菜单项，菜单项查询。2、需求规格1. 新增菜单项输入第-15- 页功能编码、功能名称、功能描述、创建日期、创建人、最后修订日期、最后修订人员、可用状态。输出数据保存成功/失败处理1 对输入数据项的合法性验证，日期包括时间；2 提交保存菜单项信息到数据库；3 在维护菜单项信息时，菜单可以树形方式展现。提
18、示成功/失败信息；约束（无）2. 菜单项查询输入菜单项编码、菜单项名称输出列表显示符合条件的菜单项信息。处理4 依据输入条件约束，进行数据合法性检查；5 列表显示数据库返回的信息。6 选定指定用户，可以查看显示用户的明细信息；约束4.2.2. MAS 基础服务1、功能说明要求系统能够提供设计手机上传的 IP 接口服务信息设置，能够通过本接口接收发送的日志信息数据。本模块提供启动、停止和监控日志接受服务。2、需求规格输入第-16- 页无输出服务名称、服务状态。处理1 选择基础服务，开启日志接收服务；2 选择停止服务，停止日志接受服务。3 实时监控日志服务的运行状态；约束无界面参考4.2.3. 手
19、机登陆日志1、功能说明要求系统能其他系统的登录日志文件，并能够打开文件分析信息发日志到日志数据库。一般其他系统的文件格式是 TXT 格式文件。日志系统要求能够读取指定服务器上的 TXT 文件，并分析相关的文件内容，将信息保存到日志系统。2、需求规格1. 接受日志文件输入文件名称、文件路径 输出列表显示符合条件的手机登陆信息。第-17- 页处理4 依据输入条件约束，进行数据合法性检查；5 列表显示数据库返回的信息。6 选定指定记录，可以查看显示手机登陆的明细信息；约束指定文件已经存在；2. 日志文件查询输入时间段、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态。输出列表
20、显示符合条件的日志信息：时间、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态。处理1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 选定指定日志记录，可以查看日志的明细信息；约束3. 登陆日志的统计分析输入时间段、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态。输出列表显示符合条件的日志信息，具体列表包括：列表显示符合条件的日志信息：时间、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态。处理1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 选定指定日志记录，可以查看
21、手机登陆日志的明细信息；第-18- 页约束4.2.4. 系统应用日志业业(from Use Case View)业业业业业业20业业业业业业业业业(EXCEL业)业业业4.2.5. 平台操作日志1、功能说明要求系统能够按照指定的要求统计本系统的操作日志信息，并依据日志的时间分类，按照时间可以分为按年、按月、按日、按时间段统计本系统各个模块的操作日志信息。并依据统计数据报表，可以生成统计报表、导出统计数据和报表服务。2、需求规格1. 平台日志查询统计输入按日期段统计：选择起始、截止日期及统计方式、用户名、设备号、终端、服务器 ip、操作模块、操作类型、操作状态。按年统计:选择要统计的年份及统计方
22、式、用户名、设备号、终端、服务器 ip、操作模块、操作类型、操作状态。按月统计：选择要统计的年份、月份及统计方式、用户名、设备号、终端、服务器 ip、操作模块、操作类型、操作状态。输出按日期段统计：用户名，操作次数。最后显示合计次数。点击进入该用户的操作日志列表。在日志列表，可查看详情：包括“字段说明”中的所有字段。第-19- 页按年统计、按月统计：操作次数。点击进入操作日志列表。在日志列表，可查看详情：包括“字段说明”中的所有字段。处理1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 选定指定日志记录，可以查看平台日志的明细信息；约束无参考界面日志明细第-20- 页
23、2. 平台日志报表导出输入按日期段统计：选择起始、截止日期及时间段、用户名、设备号、终端、服务器ip、操作模块、操作类型、关键字、操作状态输出按日期段统计：用户名，操作次数。最后显示合计次数。点击进入该用户的操作日志列表。在日志列表，可查看详情：包括“字段说明”中的所有字段。按年统计、按月统计：操作次数。点击进入操作日志列表。在日志列表，可查看详情：包括“字段说明”中的所有字段。处理1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 选定指定日志记录，可以查看平台日志的明细信息；4 将生成的统计日志信息，导出为指定文件名的 EXCEL 文件；约束3. 平台日志报表打印输
24、入时间段、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态。第-21- 页输出列表显示符合条件的日志信息，具体列表包括：列表显示符合条件的日志信息：时间、用户名、设备号、终端、服务器 ip、操作模块、操作类型、关键字、操作状态。处理1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 打印平台日志统计报表；约束4. 平台日志清除输入按日期段统计：选择起始、截止日期及时间段、用户名、设备号、终端、服务器ip、操作模块、操作类型、关键字、操作状态输出按日期段统计：用户名，操作次数。最后显示合计次数。点击进入该用户的操作日志列表。在日志列表，可查看详情：
25、包括“字段说明”中的所有字段。按年统计、按月统计：操作次数。点击进入操作日志列表。在日志列表，可查看详情：包括“字段说明”中的所有字段。处理1 依据输入条件约束，进行数据合法性检查；2 列表显示数据库返回的信息。3 选定指定日志记录，提供清除日志记录；4 选择清除日志记录时，提供支持多选和全选方式；约束1 系统指出单选日志、多选和全选功能；4.2.6. 应用日志统计1、功能说明要求系统能够按照指定的要求统计业务日志信息，并依据日志的时间分类，按照时间第-22- 页可以分为按年、按月、按日、按时间段统计应用系统（手机端系统）各个模块的操作日志信息。并依据统计数据报表，可以生成统计报表、导出统计数
26、据和报表服务。2、需求规格1. 按月统计输入选择月份（所有的日志统计（不仅仅是应用日志统计） ，如果选择按月统计，必须出现年份列表和月份列表）输出1 列表显示符合条件的应用日志统计信息。2 单月列表显示：日期、操作用户、系统使用次数、各个业务模块的操作次数。处理1 依据输入条件约束，选定统计月份，进行数据合法性检查；2 统计指定月份中每一日各个用户在系统中各个模块的操作次数；3 列表显示数据库返回的信息。4 选定所有月份，可以查看的所有月份中各月每一日的操作明细日志；约束1 下拉选择月份时，除了从 1-12 个月份外，尚需要增加“全部” ，表示选择 12个月；2 注意：是每个月的每一天（可能
27、28 天 可能 31 天） ；界面参考是选择月份的每一天的操作次数（如选择了 2011 年 8 月；统计结果就是该月 1 号-31号的每一天的操作次数，然后点击 1 号，输出的结果是 1 号所有操作用户的操作次数（如下图） ，点击用户名，输出的结果是该用户在 2011 年 8 月 1 号的所有操作记录，然后点击该记录，可以查看该条记录的详细内容。 （每个页面需提供返回上一个页面的按钮）第-23- 页2. 按年统计输入选择年份，或年份时间段；输出1 列表显示符合条件的应用日志统计信息。2 每一年 12 月列表显示：月份、操作用户、系统使用次数、各个业务模块的操作次数。是选择年份的每一个月的操作次
28、数（如选择了 2011 年；统计结果就是该年 1 月-12月的每一月的操作次数，如果点击 1 月，输出的结果是 1 月所有操作用户的操作次数（如下图） ，点击用户名，输出的结果是该用户在 2011 年 1 月的所有操作记录，然后点击该记录，可以查看该条记录的详细内容。 （每个页面需提供返回上一个页面的按钮）处理1 依据输入条件约束，选定统计月份，进行数据合法性检查；2 统计指定年份中 12 个月各个用户在系统中各个模块的操作次数；3 列表显示数据库返回的信息。4 选定年份段，可以查看的各年中 12 个月份中各月操作明细日志，如 20110 年至 2011 年每年 12 个月的操作信息；约束1 下拉选择年份时，除了从可选单个年份外，尚需要增加年份段（即起始年份和终止年份，如：2010-2011 年） ，表示选择统计 2010 年到 2011 年各年 12 个月中业务操作次数；2 选择查询指定月份记录，可以查看该月份的业务使用次数；界面参考第-24- 页
