日志系统用概要设计说明书.docx

《日志系统用概要设计说明书.docx》由会员分享，可在线阅读，更多相关《日志系统用概要设计说明书.docx（26页珍藏版）》请在第一文库网上搜索。

1、案卷号日期日志系统概要设计说明书作 者：曾琦，杨兴，龚锡寒完成日期：住定签收人：签收日期：修改情况记录:版本号修改批准人修改人安装日期签收人目录1引言O1.1 编写目的O1.2 范围O1.3 定义O1.4 参考资料12总体设计12.1 需求规定12.1.1 根本功能12.1.2 根本需求22.2 运行环境31硬件环境32软件环境32.3 根本设计概念和处理流程4231业务流程设计42.3.2数据流程设计112.4 结构122.5 功能需求与程序的关系132.6 人工处理过程142.7 尚未解决的问题143接口设计143.1 用户接口错误!未定义书签。3.2 外部接口143.3 内部接口154运

2、行设计154.1 运行模块组合184.2 运行控制194.3 运行时间235系统数据结构设计235.1 逻辑结构设计要点235.2 物理结构设计要点235.3 数据结构与程序的关系236系统出错处理设计246.1 出错信息246.2 补救措施246.3 系统维护设计241引言1.1 编写目的本文档系统描述了日志系统的设计，主要阅读对象为日志系统的工程经 理及软件开发人员，测试日志系统的测试人员，需求分析师等。工程经理：阅读本文档的全部描述信息，开发人员：重点阅读是外部接口和内部接口局部。需求分析师以及测试人员：重点阅读是需求概述局部。1.2 范围软件系统名称：日志系统1.3 定义列出本文件中用

3、到的专门术语的定义和缩写词的原词组。1.4 参考资料2总体设计2.1 需求规定2.1.1 根本功能日志系统无论是作为一个独立的系统还是作为其他系统的子系统都应具备2 个根本的功能2.1.1.1 日志来源日志来源可以是使用日志系统的用户自己或者其他调用日志系统的人，又或 是其他需要记录软件日志的使用者。2.1.1.2 日志输出作为一个日志系统，需要有提供日志显示的功能。当日志系统记录了日志时 就应当提供日志显示的功能给使用者查看这些日志，这样才能提现这些日志的价 值。当然日志系统还可以根据用户的需要增加一些自定义的功能：比方：日志的 导出和日志的打印，以便用户在需要对有价值的信息进行特定格式的保

4、存或者打 印成文档的时候使用。2.1.2根本需求2.1.2.1 记录日志功能日志系统提供记录日志的功能，记录的日志可以有软件的运行、用户 的操作行为。软件的运行包括：软件的运行状态，用户的操作行为包括：用户使 用软件提供的功能时的行为。记录的日志信息包括：操作类型、操作结果、操 作时间、操作者、操作目标、操作者的IP地址。2.1.2.2 查询日志功能日志系统提供用户日志、物流配送日志、员工信息日志、教务管理系统 日志供用户查询，使用者可以根据 日志系统提供的查询条件自行指定的条件 进行查询。用户日志可以根据：用户ID、IP地址、用户级别、开始时间、结束时间 5个条件来查询需要的日志；物流配送日

5、志可以依据：子系统、操作类型、操作结果、用户ID、源文 件、目的文件、开始 时间、结束时间等9个条件来查询；员工信息管理系统日志可以根据：子系统、操作类型、操作结果、用户ID、预置点编号、目标地址、开始时间、结束时间等9个条件来查询； 教务管理系统日志那么可以根据：子系统、用户口、操作类型、操作目 标、操作结果、开始时间、结束时间等6个条件查询。使用者可以自行决定搜索条件来查询所需要的日志，日志系统将符合搜 索条件的日志显示到界面供用户查看。2.1.2.3 日志的导出功能当使用者通过日志查询查询出日志后，可以选中某些需要保存的日志使 用日志导出功能将这些日志保存为TXT或是WORD格式的文件。

6、如果要保存 为WORD格式的文件，必须保证使用者的电脑已经安装了 OFFICE软件，否那么会导出失败。2.1.2.4 日志的打印功能当使用者通过日志查询查询出日志时，可以将对选中的日志信息进行打印操 作。使用打印操作之前必须保证电脑已经连接上了打印机，否那么将无法打印。2.1.2.51硬件环境处理器：PentiUm 3或性能更好的处理器。内存：512MB或以上。硬盘空间：500MB或以上的剩余空间。本系统对于硬件的要求不算太高，选择计算机主要是本着经济、运行稳定的 原那么。目前主流的PC机就可以满足本系统的运行要求。2软件环境系统环境：只支持MiCrOSOft （微软）操作系统。版本代号为XP

7、 SP2或者比次版本更高的系统，如：Windows 2003, Windows Vista, Windows 7。数据库：MYSQL5.5数据库或更高版本的MYSQL。WindoWS操作系统以其友好的图形界面，以及简单的操作要求，深受用户的 青睐，另外他对使用者要求相对其他系统简单，所以一般用户都能直接上手。基 于上述的考虑，选择WindOWS系统作为软件的运行环境，方便使用者的操作。业务流程设计2.3.1.1 初始化用户界面流程2.3.1.2 写入软件运行日志流程结束2.3.1.3读出软件运行日志流程2.3.1.4搜索日志流程子流程或分支处理流程设计日志系统用户界面模块流程图处理设计结束数据

8、流程设计2.3.2.1写入日志信息数据库23.2.2读出日志信息日志信息2.3.2.3搜索用户日志日志信息2.4结构用一览表及框图的形式说明本系统的系统元素各层模块、子程序、公用程 序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之 间的控制与被控制关系。日志系统记录日志功能_t写入物流配送日志写入员工信息日志写入教务管理日志写入用户日志查询日志功能界面功能自定义功能查询用户日志导出日志查询员工信息日志查询物流配送日志打印日志查询教务管理日志2.5 功能需求与程序的关系数据库操作 模块日志系统用户界面 模块外部接口连接数据库执行SQL语句获取行获取值获取字段长度释放数据指针

9、关闭数据库初始化界面选择日志类型7读取日志写入日志搜索日志退出客户端2.6 人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程如果有的话)。2.7 尚未解决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的 各个问题。3接口设计3.1 外部接口接口数据类型说明:Char*字符指针Const常量BOOL布尔型VOID 空返回值函数功能需求对应1BOOLWriteLog(char LogInfo, int nLogType )根据nLogtype的类型写入对应 的日志1. 11. 21. 31.42VOIDShowLogSysDlg )显示日志系统用户界面，便于用

10、 户查询日志和导出、打印日志2. 12.22. 32.434BOOL WriteLogCchar *pLogInfo, int nLogType)功能：写入日志，根据nLogType的值写入对应的日志。nLogType的取值详见参数说明参数：第一个参数以结构体字符串常量形式传入,第二个为一个整形变量，可选值为其下面其中之一:USERLOG：用户日志；LogisticsLog :物流配送日志EmployeeLog: 员工信息 日 志EducationalLog:教务系统日志；返回值：假设写入成功，返回TRUE,否那么返回FALSE。无返回值 ShowLogSysDlg ()功能：显示日志系统用户

11、界面。参数：无。返回值：无。3.2 内部接口接口列表如下:返回值函数功能1BOOLInitAccessDBO初始化数据库2BOOLCloseAccessDBO关闭数据库3BOOLStoreIPAddr ()将登录过主系统的用户的IP写入下拉 列表4BOOLStoreUserIDO将登录过主系统的用户的ID写入下拉 列表5BOOLGetsoftwareLogChoices()当用户对软件运行日志进行搜索时，获 取用户选择的筛选条件6BOOLGetuserLogChoices()当用户对用户日志进行搜索时，获取用 户选择的筛选条件7BOOLInitComboBox ()对除用户ID及用户IP以外的

12、下拉列表 框进行初始化8BOOLInitColumnO对列表控件进行初始化9BOOLReadSof twareLogFromDB( const char* szSql )将软件运行日志从数据库中读出10BOOLReadUserLogFromDB()将用户日志从数据库中读出11BOOLInitImageList()初始化图标列表12BOOLGetLastUser ()取得数据库中最后一个用户记录，作为 当前系统的使用者13BOOLOnSoftwareLogSearch ()搜索软件运行日志14BOOLOnUserLogSearch()搜索用户日志BOOL InitAccessDBO功能：初始化数

13、据库。参数：无。返回值：假设成功返回TRUE,否那么返回FALSE。BOOL CloseAccessDB()功能：关闭数据库。参数：无。返回值：假设成功返回TRUE,否那么返回FALSE。BOOL StoreIPAddrO功能：将登录过主系统的用户的IP写入下拉列表。参数：无。返回值：假设成功返回TRUE,否那么返回FALSE。BOOL StoreUserIDO功能：将登录过主系统的用户的ID写入下拉列表。参数：无。返回值：假设成功返回TRUE,否那么返回FALSE。BOOL GetsoftwareLogChoices()功能：当用户对软件运行日志进行搜索时，获取用户选择的筛选条件。参数：无。返回值：假设成功返回TRUE,否那么返回FALS