日志管理概要设计说明书.doc

1引言 2
1.1编写目的 2
1.2背景 2
1.3定义 2
1.4参考资料 2
2总体设计 2
2.1需求规定 2
2.2运行环境 2
2.3基本设计概念和处理流程 3
2.4结构 3
2.5功能器求与程序的关系 3
2.6人工处理过程 3
2.7尚未问决的问题 3
3接口设计 3
3.1用户接口 3
3.2外部接口 3
3.3内部接口 4
4运行设计 4
4.1运行模块组合 4
4.2运行控制 4
4.3运行时间 4
5系统数据结构设计 4
5.1逻辑结构设计要点 4
5.2物理结构设计要点 4
5.3数据结构与程序的关系 4
6系统出错处理设计 5
6.1出错信息 5
6.2补救措施 5
6.3系统维护设计 5

日志管理概要设计说明书
1引言
1.1编写目的
说明编写这份概要设计说明书的目的，指出预期的读者。
1.2背景
说明：
a. 待开发软件系统的名称；
b. 列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。
1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料
列出有关的参考文件，如：
a. 本项目的经核准的计划任务书或合同，上级机关的批文；
b. 属于本项目的其他已发表文件；
c. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2总体设计
2.1需求规定
l 对绘制图形等操作保存业务操作日志。
l 对日志的浏览
l 对日志的备份
l 对日志的删除、清空
2.2运行环境
l 操作系统
n Windows2000Server
n Windows2003
l 数据库
n Oracle
2.3基本设计概念和处理流程
本系统仅对绘制图形等操作保存业务操作日志。保存日志的流程如下图所示：

2.4结构
l 日志内容字段.
n 图形ID
n 用户ID
n 操作字
n 操作时间
n 操作描述
2.5功能需求与程序的关系

日志记录服务子模块
对绘制图形等操作保存业务操作日志
√
对日志的浏览
√
对日志的备份
√
对日志的删除、清空
√
2.6人工处理过程
本模块无人工处理过程。
2.7尚未问决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3接口设计
3.1用户接口
l 日志管理
n 查看看日志
n 删除日志
n 备份日志到文件
l 日志设置
n 定时启动
n 定时停止
n 定时清空
n 指定条件清空（如已满n条）
3.2外部接口
l 写日志
l 读日志
l 查询日志
l 删除日志
l 清空日志
l 日志数量
l 导出日志
3.3内部接口
l 创建日志表
l 写入一条日志记录
l 清空日志表
l 查询日志表
l 删除指定日志记录
4运行设计
4.1运行模块组合
日志管理模块提供写日志、读日志等接口供总系统的其他模块调用。
4.2运行控制
l 负责系统操作的模块发生操作动作需要记录日志时调用本模块的写日志接口进行写日志操作。
l 用户需要浏览日志、备份日志等操作时由相关模块调用本模块的读日志、导出日志接口来实现。
4.3运行时间
写一条日志所占用的系统时间可忽略不计
5系统数据结构设计
5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
字段名
字段类型
字段说明
ghID
图形ID

usID
用户ID

action
操作类型
Enum
datetime
操作时间
Time
actionremark
操作描述
String

5.2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。
5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
6系统出错处理设计
6.1出错信息
在日志操作的过程中，如出现异常或严重错误，模块将给出错误信息。
l 连接数据库失败
l 数据库操作异常（代码。。。）
l 要浏览的日志不存在
l 要删除的日志不存在
l 日志记录已满
6.2补救措施
一旦日志管理操作失败，模块将把与当前操作相关的信息以文本文件的形式写入一个临时磁盘文件里如（error.txt），文件路径根据系统总体设定。