日志系统用概要设计说明书
Broadesoft日志系统使用说明书
DATA SHEETInnovation and Business Value—On Your ScheduleSoftware-Defined Networking (SDN) is a rapidly evolving approach to networking. Organizations typically cite two main reasons for exploring SDN:1• D evice interoperability and the ability to choose networking platforms independently of architectural needs• T he need for programmability to support rapid service design, development, and teardownHIGHLIGHTS•Provides a fully tested, extensible commercial distribution of theOpenDaylight controller, the leading open-source SDN controller with a large, vibrant developer community •Builds an agnostic solution based on OpenDaylight that is free ofproprietary extensions and provides complete portability for various applications and plugins •Delivers the broadest platform for use in multivendor environments—with the ability to control physical and virtual networking devices from all major vendors •Fosters a collaborative relationship for innovation, enabling the creation of SDN environments that meet the needs of service providers and enterprises alike •Enables high availability and disaster recovery capabilities for data backup and restore across multiple sites •Comes packaged with education and professional services to helporganizations develop and deliver their own business logic, use cases, and custom network services •Includes single-source, 24×7 technical support for the entire Brocade SDN Controller environmentThe majority say open source is a key decision factor in SDN technology selection. At the same time, adopting a new approach to network operations is not a minor undertaking, and users expect their technology partners to be able toassist in making the transition as seamless as possible.The OpenDaylight Project , founded in April 2013, is operated by the Linux Foundation with the charter to establish a reference framework for network programmability and control through an open-source solution for SDN. The Brocade® SDN Controller is the first commercial distribution of the OpenDaylight Project with no proprietary extensions or platform dependencies. Brocade views the OpenDaylight community as a force multiplier forinnovation with and on behalf of controllerusers and developers. Brocade’scommunity leadership and multifaceted support help organizations of all kinds accelerate the delivery of new services while optimizing their business operations.The Brocade SDN Controller package includes tools and services to quickly and confidently implement software-defined networks within existing environments. Brocade provides multivendor compatibility testing and complete, single-source support for Brocade SDN Controller environments, backed by the expertise of leaders within the OpenDaylight developer community.Smooth Transition to SDNBrocade is committed to providing the best experience for transitioning to open SDN.1GigaOm Research, “SDN, NFV, and Open Source: The Operator’s View,” March 2014.2Low RiskThree-quarters of users interested in open-source SDN want to get the technology from a commercial provider in order to reduce adoption risks andhave reliable support*. The Brocade SDN Controller is fully tested, documented, and quality assured by an establishednetworking provider with global resources. As the Brocade SDN Controller is continuously built on OpenDaylight code, defect resolution is promptly shared with the community and incorporated upstream. In addition, Brocade has committed to contributing any enhancements made to the Brocade SDN Controller (such as improvements for scalability, reliability, high availability, and usability) to the community to ensure interoperability with other OpenDaylight-based controllers on an ongoing basis. These practices continually improve the quality and reliability of the source code.At the same time, new features, functions, and enhancements can be incorporated into the controller within weeks instead of months.For user organizations that want to deploy open-source SDN with confidence,Brocade and its partners provide a rangeof support, education, and professional services options. Brocade Professional Services helps Brocade SDN Controller customers realize the full power of SDN by providing consulting expertise to assist with SDN architectural planning, implementation, and developmentefforts. Additionally, Brocade education courses, available in multiple formats, provide the conceptual foundation and skills that IT organizations need to adopt SDN successfully. Community support resources may be found at /devnet .Investment ProtectionA common reason for delaying SDN implementation is the fear that it will require replacing existing equipment before it has depreciated. Some SDN controllers do have platformdependencies that constrain a controller domain to a single vendor’s gear. Creating several vendor-specific controller domains also can lead to controller proliferation and interoperability challenges—further complicating operations.OpenDaylight and the Brocade SDN Controller are designed to be general-purpose SDN controllers. The Brocade SDN Controller is platform-independent as well as host OS- and hypervisor-agnostic, making it the best choice for implementing SDN in existing heterogeneous data centers. Any networking equipment—physical orvirtual—from any provider can be operated within the controller domain as long as it is compatible with any of the standard OpenDaylight southbound interfaces or has an OpenDaylight plugin. With the Brocade SDN Controller, IT organizations can gradually introduce ever-largerportions of their existing network into the controller domain without disruption. Furthermore, Brocade provides single-source technical support for the entire Brocade SDN Controller environment, including troubleshooting connections with third-party platforms. Organizations can freely optimize their network infrastructures to match the needs of their workloads, and develop network applications that can run on any OpenDaylight-based controller (see Figure 1).Figure 1: The Brocade SDN Controller is part of an open, modular portfolio.VirtualPhysicalThird-PartyContinued Operations without InterruptionsThe Brocade SDN Controller is a reliable, highly available solution that helps ensure customer SLAs are met regardlessof any failure. It provides a clustering solution within and across data centersto keep workloads up and running while simplifying data backup and restore. Brocade has fine-tuned the code upstream in the OpenDaylight controller, by providing various scripts and toolsthat make it easier for network operators to utilize this functionality and maximize uptime in customer environments. Smooth Installation and MaintenanceThe Brocade SDN Controller offer includes many value-enhancing toolsand tested solutions to reduce time-to-competence and ongoing administrative overhead, including:•One-click controller setup, detailed deployment guides and tutorials, and architectural planning services•An intuitive GUI to reduce training time and scale repeatable operations•T ested solution packages to support a broad range of use cases•Release and revision compatibility managementEasy Upgrade via Data Migration Network operators can now easily upgrade to the latest version of the Brocade SDN Controller. Instead of having to manually re-enter all of their data, they can simply export the data file and import it into the latest version of the controller. This enables a smooth upgrade, with much less risk of error, while increasing operational efficiency and productivity. Framework for Innovation Network operators expect most of SDN’s near-term benefits to be operational in nature: greater management efficiency,fewer interoperability challenges, andpossible OpEx reductions. However, theoriginal promise of SDN—faster, custominnovation through programmability—provides an even stronger business casefor SDN adoption.Brocade Provides the Bridge forUser OrganizationsIn an era when specialized networkdeveloper skills are still a rare commodity,an OpenDaylight-based controllerprovides access to the industry’s largestpool of SDN developer talent and codelibraries. Some organizations may chooseto be consumers of the OpenDaylightProject via the Brocade SDN Controller.By leveraging the history and technicaldepth of Brocade engineering personnelwithin the OpenDaylight community,organizations can realize productenhancements without having to burdentheir own development resources.In addition, Brocade can co-design and,if desired, build custom applicationsto support unique use cases andenvironments—or refer customers to aqualified partner to meet their needs.Brocade understands that many of theseapplications are specific to the operator’sbusiness and takes formal measures toprotect the operator’s environment andintellectual property.For user organizations that wish to buildtheir own applications, Brocade providesa Developer Edition with a range ofdeveloper tools; free Web-based trainingand formal developer courses; a publicYANG repository; and free Perl, Postman,Python, and Ruby libraries for the BrocadeSDN Controller to simplify and speedapplication development. See the BrocadeSDN Controller Developer Editiondatasheet for details.Brocade SDN Applications GetYou StartedBrocade is investing in developing anecosystem of OpenDaylight-basedapplications, on its own and withpartners. These applications are licensedindependently of the Brocade SDNController to ensure continuous integrityof the controller and full applicationportability.For more information, contact a Brocadesales representative or partner, or visit.Brocade Global ServicesBrocade Global Services has theexpertise to help organizations buildscalable, efficient cloud infrastructures.Leveraging 20 years of expertise instorage, networking, and virtualization,Brocade Global Services delivers world-class professional services, technicalsupport, and education services,enabling organizations to maximize theirBrocade investments, accelerate newtechnology deployments, and optimize theperformance of networking infrastructures.Acquisition Options ThatMatch Balance SheetObjectivesSuccessful network deployments drivebusiness forward, providing technicaland financial agility. Brocade offersthe broadest financing models, fromtraditional leasing to Brocade NetworkSubscription. Network-as-a-Serviceallows organizations to subscribe tonetwork assets today then upgrade ondemand, scale up or down, or return themwith 60-day notification. Brocade NetworkSubscription plans can be structured tomeet IASC guidelines for OpEx or CapExtreatment to align with financial goals.Learn more at .3Northbound Plugins Supported •Restconf Plugin•OpenStack Neutron, ML2 Driver Southbound Plugins Supported •OpenFlow 1.0 and 1.3•NETCONF/YANG (RFC 6241/6020) •OVSDB•BGP-LS/PCE-PSpecific OpenFlow Features Supported Please refer to the user guide for a complete list of supported OpenFlow CONF Protocol Version 1.1, RFC 6241Please refer to the user guide for a complete list of supported NETCONF features.Brocade SDN Controller SpecificationsYANG Protocol, RFC 6020More than 200 YANG models are supported by the Brocade SDN Controller Developer Edition. Please refer to the User Guide for a complete list of supported YANG models. OpenDaylight Controller Modules SupportedPlease refer to the Release Notes for a list of supported modules and projects.Supported Platforms/OS •RedHat RHEL—7.2 •Ubuntu—14.04Software and SupportBR-9500-5N-LIC-SVV-SW-60D Promotion for five nodes or fewer, including 60-day support offer BR-9500-1NODE-SVV-SW-1 1 node license (paper)—1 year; includes support BR-9500-1NODE-SVV-SW-3 1 node license (paper)—3 years; includes supportProfessional Services SVC-CONTROLLER-SME Consulting time with a subject matter expert for Brocade SDN Controller customers; per hour SVC-CONTROLLER-INSTALL Contract Brocade SDN Controller implementation; SOWEducation BSC200Brocade SDN Controller for operations—3 days BSC201Brocade SDN Controller for developers—4 daysContact Brocade Education Services for pricing and availability.Brocade SDN Controller Ordering InformationWeb UI Support •Firefox v45 •Chrome v49Service Interfaces•Karaf: / (3.0.4) •OSGi: / •Akka: http://akka.io (2.4.1) Recommended Minimum Server Configuration• 3.0 GHz Intel Xeon or Intel Core: 4 cores or equivalent •RAM: 12 GB •Storage: 64 GB•Network: At least 1 Gbps Ethernet© 2016 Brocade Communications Systems, Inc. All Rights Reserved. 09/16 GA-DS-1872-05Brocade, Brocade Assurance, the B-wing symbol, ClearLink, DCX, Fabric OS, HyperEdge, ICX, MLX, MyBrocade, OpenScript, VCS, VDX, Vplane, and Vyatta are registered trademarks, and Fabric Vision is a trademark of Brocade Communications Systems, Inc., in the United States and/or in other countries. Other brands, products, or service names mentioned may be trademarks of others.Notice: This document is for informational purposes only and does not set forth any warranty, expressed or implied, concerning any equipment, equipment feature, or service offered or to be offered by Brocade. Brocade reserves the right to make changes to this document at any time, without notice, and assumes no responsibility for its use. This informational document describes features that may not be currently available. Contact a Brocade sales office for information on feature and product availability. Export of technical data contained in this document may require an export license from the United States government.Corporate Headquarters San Jose, CA USAT: +1-408-333-8000 ****************European Headquarters Geneva, Switzerland T: +41-22-799-56-40 *********************Asia Pacific Headquarters SingaporeT: +65-6538-4700 *********************。
系统概要设计说明书(模板)
XXX项目系统概要设计说明书广州市XX有限公司二〇X X年X月文档修改记录目录第一章引言 (1)1.1目的 (1)1.2背景 (1)1.3术语定义 (2)1.4参考资料 (2)第二章系统环境 (3)1.5运行环境 (3)1.1.1系统支撑环境 (3)1.1.2部署图 (4)1.1.3系统接口 (4)1.1.4系统安全控制 (4)1.6运行模块组合 (4)1.7运行环境的配置 (4)1.8条件与限制 (5)第三章系统总体结构设计 (6)1.9系统结构设计描述 (6)1.10总体结构图 (7)1.11功能需求与程序的关系 (7)1.12子系统清单 (8)第四章模块功能分配 (9)1.13系统划分及功能描述 (9)1.14专用模块功能概述 (9)1.15公用模块功能概述 (10)1.1.5版本控制管理 (10)1.1.6帮助模块 (10)第五章数据库设计 (11)1.16逻辑视图 (12)1.17数据库表关系图 (12)1.18数据表清单 (12)1.19主要算法设计 (13)1.20其它数据结构设计 (13)第六章接口设计 (14)1.21用户接口 (14)1.22内部接口 (14)1.23外部系统接口 (14)第七章安全保密设计 (16)1.24用户管理和权限控制 (16)第八章维护及出错处理设计 (17)1.25系统维护设计 (17)1.26出错信息 (17)1.27出错处理 (17)1.28系统故障预防与恢复 (17)1.29数据备份与恢复 (18)第九章设计约束 (19)1.30字节集编码约束 (19)1.31操作系统约束 (19)1.32其他约束 (19)第十章附件 (20)第一章引言1.1目的提示：简要说明编写这份概要设计说明书的目的，指出预期的读者。
概要设计说明书的编写目的是为了说明系统总体设计的技术方案，从程序系统的设计考虑，包括系统的基本处理流程、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等内容，以向整个设计期提供关于程序系统的逻辑和数据功能实现方式的总体描述，从而作为程序详细设计或编码的基础。
日志记录系统设计
日志记录系统设计简介本文档旨在设计一个日志记录系统，该系统可以帮助用户方便地记录和管理日志信息。
日志记录系统对于个人和企业来说都是非常重要的，它可以记录重要事件、问题和解决方案，以及其他相关信息。
通过设计一个有效的日志记录系统，可以提高工作效率和信息管理的便捷性。
功能需求以下是日志记录系统的主要功能需求：1. 登录和用户管理：用户可以通过用户名和密码登录系统，并根据其权限访问相应的功能。
2. 日志记录：用户可以创建新日志，包括标题、日期、内容等信息。
用户还可以对现有日志进行编辑、删除和浏览。
3. 分类和标签：用户可以为日志添加分类和标签，以便更好地组织和检索日志。
4. 搜索和过滤：系统应该提供搜索和过滤功能，允许用户根据关键字、日期范围、分类或标签来查找和筛选日志。
5. 访问权限管理：系统应该具有访问权限管理功能，允许管理员控制用户对不同日志的访问权限。
6. 导出和导入：用户可以将日志导出为常见文件格式（如CSV 或PDF），以及从外部文件导入现有日志。
系统设计以下是该日志记录系统的基本设计：1. 技术架构：系统采用客户端-服务器架构，客户端通过Web浏览器访问系统，服务器端负责处理请求和存储数据。
4. 数据库设计：系统使用数据库来存储用户信息、日志数据和其他相关信息。
数据库可以使用关系型数据库（如MySQL或PostgreSQL）或NoSQL数据库（如MongoDB）来实现。
5. 安全性设计：系统应该实现基本的安全性措施，如用户身份验证、访问控制和数据加密，以保护用户的隐私和数据安全性。
6. 用户界面设计：用户界面应该简洁、直观，易于使用和导航。
系统应该提供明确的操作指导和错误处理机制，以提高用户体验。
实施计划以下是该日志记录系统的实施计划：1. 需求分析：了解用户需求和系统功能需求，进行详细的需求分析和规划。
2. 设计阶段：基于需求分析结果，进行系统设计和界面设计。
确定所需的技术和工具。
3. 开发阶段：根据设计阶段的结果，进行系统开发和测试。
日志系统方案
日志系统方案引言随着互联网和云计算的发展，日志系统在软件开发和系统运维中变得越来越重要。
一个高效可靠的日志系统能够帮助开发人员和运维人员快速定位问题和调试代码，提高系统的稳定性和性能。
本文将介绍一个日志系统的基本架构和关键组件，以及一些常用的最佳实践。
日志系统架构一个典型的日志系统包含以下几个组件：•日志收集器（Log Collector）: 负责从各个应用程序和系统组件中收集日志信息。
•日志存储（Log Storage）: 负责存储收集到的日志信息，通常使用分布式存储系统，如Elasticsearch或Hadoop HDFS。
•日志索引（Log Index）: 负责对日志进行索引，以便快速的检索和分析。
•日志搜索（Log Search）: 提供用户界面，让用户可以方便地进行日志搜索和查询。
•日志分析（Log Analysis）: 对存储的日志数据进行分析，以提取有价值的信息和统计数据。
•日志可视化（Log Visualization）: 将日志数据以图表和图形的方式展示，以便用户更直观地理解和分析。
日志收集器日志收集器是日志系统的关键组件之一，它负责从各个应用程序和系统组件中收集日志信息。
常见的日志收集方式有以下几种：1.基于日志框架: 许多编程语言都提供了成熟的日志框架，如Java的Log4j和Python的logging库。
通过使用这些框架，开发人员可以方便地将日志输出到文件、控制台或网络中，从而实现日志收集。
2.系统级日志: 操作系统和运行时环境通常提供了系统级日志功能，如Linux 的rsyslog和Windows的EventLog。
可以通过配置这些系统级日志来收集应用程序的日志信息。
3.应用程序日志调用接口: 对于某些定制化的应用程序，可以通过定义日志调用接口，来收集特定业务的日志信息。
日志存储日志存储是将收集到的日志信息持久化存储的过程。
传统的日志存储方式是将日志信息写入普通文件或数据库中，但随着日志量的增加，这种方式变得越来越不可行。
系统日志管理系统说明书
系统日志管理系统说明书一、概述系统日志管理系统是一种用于记录、存储和管理计算机系统运行状态、操作记录以及异常情况的软件系统。
本文档将介绍系统日志管理系统的功能、操作流程和使用说明，以便用户能够正确、高效地使用该系统。
二、功能介绍1. 日志记录：系统日志管理系统能够自动记录计算机系统的运行状态、用户操作以及系统异常情况，并将其存储于数据库中。
2. 日志存储与查询：用户可以通过系统日志管理系统对历史日志进行存储和查询，并按时间、类型、关键字等条件进行检索。
3. 异常报警：系统日志管理系统能够根据用户设定的规则，实时监测系统运行情况，及时发现异常并发送报警信息。
4. 数据分析与统计：系统日志管理系统具备数据分析和统计功能，能够对日志数据进行分析，生成报表和图表，以帮助用户了解系统运行情况和优化系统性能。
5. 安全与权限管理：系统日志管理系统具备完善的安全及权限管理，确保只有授权用户才能对系统日志进行访问和操作。
三、操作流程1. 系统登录：用户首先需要通过系统登录界面输入用户名和密码进行身份验证，并获得系统访问权限。
2. 日志记录：系统日志管理系统会自动记录系统的运行状态和用户操作，无需用户手动干预。
3. 日志查询：用户可以通过系统界面选择查询条件，如日期范围、日志类型等，进行日志查询。
系统将根据用户设定的条件进行检索，显示相应的日志列表。
4. 异常报警设置：用户可以根据系统需求，设定异常报警规则，如CPU使用率过高、磁盘空间不足等。
系统将根据设定的规则，监测系统运行情况，并在发生异常时发送报警邮件或短信。
5. 数据分析与统计：系统提供数据分析和统计功能，用户可以选择分析维度和时间范围，生成报表和图表，以便更好地了解系统运行情况和性能优化的方向。
6. 安全与权限管理：系统管理员可以设定用户角色和权限，并对用户进行管理。
不同用户角色将拥有不同的系统操作权限，以保证系统日志的安全性。
四、使用说明1. 系统登录：用户根据所获得的用户名和密码，通过系统登录界面输入，成功后将进入系统主界面。
日记管理系统设计说明
系统设计说明1 数据库部分数据模型图拷贝如下其中Customer用于记录会员信息，关键字为CustomerIDCertificateType用于记录证件类型信息Diary用于记录日记信息，关键字为DiaryIDTabDiaryAttachFile用于记录日记的附件信息，因为时间的关系，没有将附件功能实现Diarytype用于记录日记分类信息数据库中存储过程有sp_AddCustomer：添加用户sp_AddDiary：添加日记sp_CustomerChangePwd：修改密码SP_CustomerGetCompleteInfo：获取用户信息sp_CustomerLogin：用户登录sp_DeleteDiary：删除日记SP_DiaryGetAttachFilesInfo：获取附件SP_DiaryGetBriefInfo：获取日记列表SP_DiaryGetCompleteInfo：获取单条日记信息sp_GetAllCertifType 获取证件类型列表sp_GetAllCustomer：获取所有用户sp_GetDiaryType：获取日记类型列表sp_UpdateCustomer：更新用户sp_UpdateDiary：更新日记2 软件设计如下图所示是系统的分层结构图1、底层是数据库：用于存储系统中的数据信息和存储过程2、上一层是基本公用类(ponet)：可在不同应用程序中共享的类，比如对数据库访问等公用代码database类3、再上一层是本应用程序的公用类(ponent)：是根据系统的需求分析，构造的各种类，比如Customer类完成对会员信息的处理和访问，Diary类完成对日记信息的理和访问4、再上一层是web application和web service层：a) Web application负责最终用户使用本系统的各类接口类，比如各种web Form，即存放表示层的数据信息b) Web Service负责对用户进行验证，它独立于Web application可以被其它的各类应用所访问更为理想的分层是：用户所有对会员的处理均通过web service来完成，因为时间的关系还没有对这部分应用分离到web service中3 软件测试本次开发未对软件的测试进行系统的工作，按理应该根据需求撰写测试用例，根据测试用例的内容对软件进行功能测试和性能测试，测试用例的撰写根据模块的划分分别编写，测试的过程中应记录测试日志的内容。
日志管理系统功能说明书
日志管理系统功能说明书日志管理系统功能说明书1. 引言1.1 目的1.2 背景1.3 范围1.4 定义2. 总体描述2.1 系统概述2.2 用户特征2.3 系统功能2.4 运行环境3. 功能需求3.1 登录与安全3.1.1 用户身份验证3.1.2 密码安全策略3.2 日志记录与查看3.2.1 实时日志记录3.2.2 日志级别分类3.2.3 日志查询与过滤3.2.4 日志导出与归档3.3 权限管理3.3.1 用户角色与权限分配3.3.2 角色继承与继承关系管理 3.4 报警与通知3.4.1 报警规则设置3.4.2 报警通知方式3.4.3 报警信息处理3.5 日志分析与统计3.5.1 日志分析功能3.5.2 日志统计报表4. 用户界面4.1 登录界面4.2 主界面4.3 日志查看界面4.4 权限管理界面4.5 报警设置界面4.6 日志分析界面5. 非功能性需求5.1 性能要求5.2 可扩展性5.3 可靠性与可用性5.4 安全性5.5 用户友好性6. 附件附件1：数据库表结构设计附件2：界面原型设计附件3：系统接口文档7. 法律名词及注释- 用户身份验证：确认用户身份真实性的过程，通常使用用户名和密码进行验证。
- 密码安全策略：指定了密码复杂度、有效期和密码存储方式等安全要求。
- 实时日志记录：系统在运行过程中即时记录事件和错误信息。
- 日志级别分类：将日志按照不同的级别（如调试、信息、警告、错误）进行分类。
- 日志查询与过滤：用户可以通过关键字、时间范围等条件查询和过滤日志。
- 日志导出与归档：用户可以将特定的日志数据导出为文件并进行归档保存。
- 报警规则设置：用户可以定义触发报警的条件和规则。
- 报警通知方式：系统可以以短信、邮件等形式通知用户报警信息。
- 日志分析功能：系统提供分析日志的功能，例如关键字分析、异常模式检测等。
- 日志统计报表：系统可以各类报表，统计日志数据并提供可视化展示。
《系统概要设计说明书》模板
《系统概要设计说明书》模板写作要点：1．1.1编写目的：描述这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的，开发这个软件产品意义、作用、以及最终要达到的意图。
注意，如果这份软件系统概要设计报告只与整个系统的某一部分有关系，那么只定义软件系统概要设计报告中说明的那个部分或子系统。
2．1.2预期读者和阅读建议：列举本软件系统概要设计报告所针对的各种不同的预期读者，描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。
3．1.3参考资料：列举编写软件产品概要设计报告时所用到的项目中的其他文档或资料。
注意，为了方便读者查阅，所有参考资料应该按一定顺排列，尽可能详细的提供资料的信息，比如标题、版本。
4．术语与缩略语：描述在本文使用的独特的术语、定义和缩略语。
注意不是整个项目共用的术语、定义和缩略语，并且缩略语列表中必须按照滋补的升序排列。
5．2.1限制和约束：简要描述起到限制和约束作用的各种可能存在的条件，并且说明在这些条件下，应该实现的系统目标。
这些条件可能包括：技术条件、资金状况、开发环境、时间限制。
6．2.2设计原则和设计要求：描述设计人员的进行概要设计的方法和决策，通常包括:命名规则、模块独立性原则、边界设计原则、数据库设计规则、安全性和保密原则、系统易操作性要求、系统可维护性要求。
7．3系统的软件架构：描述如何将系统分解为子系统，绘制逻辑图，并用文字说明子系统的主要功能和子系统间是如何协调工作的。
注意，在描述系统分解为子系统共的时候要给出分解的原因。
列举子系统时，可以使用下表•子系统编号给出本系统中指定子系统的顺序编号：如果本系统末划分为多个子系统，仅由一个运行模块组成；则本项内容仍需要描述，但是本表内容只有一行。
•子系统英文名称给出本子系统的英文名称，该名称是在应用软件中实际使用的可执行文件名称，必须能够说明该子系统的特点。
•子系统中文名称给出本子系统的中文名称，该名称必须能够说明该子系统的特点。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
日志系统概要设计说明书作者：曾琦，杨兴，龚锡寒完成日期：待定签收人：签收日期：修改情况记录：目录1 引言 (1)1.1 编写目的 (1)1.2 范围 (1)1.3 定义 (1)1.4 参考资料 (2)2 总体设计 (2)2.1 需求规定 (2)2.1.1 基本功能 (2)2.1.2 基本需求 (3)2.2 运行环境 (4)1 硬件环境 (4)2 软件环境 (4)2.3 基本设计概念和处理流程 (5)2.3.1业务流程设计 (5)2.3.2数据流程设计 (12)2.4 结构 (13)2.5 功能需求与程序的关系 (14)2.6 人工处理过程 (15)2.7 尚未解决的问题 (15)3 接口设计 (15)3.1 用户接口.................................................................................................... 错误!未定义书签。
3.2 外部接口 (15)3.3 内部接口 (16)4 运行设计 (16)4.1 运行模块组合 (19)4.2 运行控制 (20)4.3 运行时间 (24)5 系统数据结构设计 (24)5.1 逻辑结构设计要点 (24)5.2 物理结构设计要点 (24)5.3 数据结构与程序的关系 (24)6 系统出错处理设计 (25)6.1 出错信息 (25)6.2 补救措施 (25)6.3 系统维护设计 (25)1 引言1.1 编写目的本文档系统描述了日志系统的设计，主要阅读对象为日志系统的项目经理及软件开发人员，测试日志系统的测试人员，需求分析师等。
项目经理：阅读本文档的全部描述信息，开发人员：重点阅读是外部接口和内部接口部分。
需求分析师以及测试人员：重点阅读是需求概述部分。
1.2 范围软件系统名称：日志系统1.3 定义列出本文件中用到的专门术语的定义和缩写词的原词组。
1.4 参考资料2 总体设计2.1 需求规定2.1.1 基本功能日志系统无论是作为一个独立的系统还是作为其他系统的子系统都应具备2个基本的功能2.1.1.1 日志来源日志来源可以是使用日志系统的用户自己或者其他调用日志系统的人，又或是其他需要记录软件日志的使用者。
2.1.1.2 日志输出作为一个日志系统，需要有提供日志显示的功能。
当日志系统记录了日志时就应当提供日志显示的功能给使用者查看这些日志，这样才能提现这些日志的价值。
当然日志系统还可以根据用户的需要增加一些自定义的功能：比如：日志的导出和日志的打印，以便用户在需要对有价值的信息进行特定格式的保存或者打印成文档的时候使用。
2.1.2 基本需求2.1.2.1 记录日志功能日志系统提供记录日志的功能，记录的日志可以有软件的运行、用户的操作行为。
软件的运行包括：软件的运行状态，用户的操作行为包括：用户使用软件提供的功能时的行为。
记录的日志信息包括：操作类型、操作结果、操作时间、操作者、操作目标、操作者的IP地址。
2.1.2.2 查询日志功能日志系统提供用户日志、物流配送日志、员工信息日志、教务管理系统日志供用户查询，使用者可以根据日志系统提供的查询条件自行指定的条件进行查询。
用户日志可以根据：用户ID、IP地址、用户级别、开始时间、结束时间5个条件来查询需要的日志；物流配送日志可以依据：子系统、操作类型、操作结果、用户ID、源文件、目的文件、开始时间、结束时间等9个条件来查询；员工信息管理系统日志可以根据：子系统、操作类型、操作结果、用户ID、预置点编号、目标地址、开始时间、结束时间等9个条件来查询；教务管理系统日志则可以根据：子系统、用户ID、操作类型、操作目标、操作结果、开始时间、结束时间等6个条件查询。
使用者可以自行决定搜索条件来查询所需要的日志，日志系统将符合搜索条件的日志显示到界面供用户查看。
2.1.2.3 日志的导出功能当使用者通过日志查询查询出日志后，可以选中某些需要保存的日志使用日志导出功能将这些日志保存为TXT或是WORD格式的文件。
如果要保存为WORD格式的文件，必须保证使用者的电脑已经安装了OFFICE软件，否则会导出失败。
2.1.2.4 日志的打印功能当使用者通过日志查询查询出日志时，可以将对选中的日志信息进行打印操作。
使用打印操作之前必须保证电脑已经连接上了打印机，否则将无法打印。
2.2 运行环境1 硬件环境处理器：Pentium 3或性能更好的处理器。
内存：512MB或以上。
硬盘空间：500MB或以上的剩余空间。
本系统对于硬件的要求不算太高，选择计算机主要是本着经济、运行稳定的原则。
目前主流的PC机就可以满足本系统的运行要求。
2 软件环境系统环境：只支持Microsoft (微软) 操作系统。
版本代号为XP SP2 或者比次版本更高的系统，如：Windows 2003，Windows Vista，Windows 7。
数据库：MYSQL5.5数据库或更高版本的MYSQL。
Windows操作系统以其友好的图形界面，以及简单的操作要求，深受用户的青睐，另外他对使用者要求相对其他系统简单，所以一般用户都能直接上手。
基于上述的考虑，选择Windows系统作为软件的运行环境，方便使用者的操作。
2.3 基本设计概念和处理流程2.3.1业务流程设计2.3.1.2 写入软件运行日志流程2.3.1.3 读出软件运行日志流程2.3.1.4 搜索日志流程2.3.1.5子流程或分支处理流程设计2.3.1.5.1 数据库操作模块流程图处理设计2.3.1.5.2日志系统用户界面模块流程图处理设计2.3.2数据流程设计2.3.2.1 写入日志信息2.3.2.2 读出日志信息2.3.2.3 搜索用户日志2.4 结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。
2.5 功能需求与程序的关系2.6 人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。
2.7 尚未解决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
3 接口设计3.1 外部接口接口数据类型说明：Char* 字符指针Const 常量BOOL 布尔型VOID 空BOOL WriteLog(char *pLogInfo, int nLogType)功能：写入日志，根据nLogType的值写入对应的日志。
nLogType的取值详见参数说明参数：第一个参数以结构体字符串常量形式传入，第二个为一个整形变量，可选值为其下面其中之一： USERLOG：用户日志;LogisticsLog:物流配送日志EmployeeLog：员工信息日志EducationalLog：教务系统日志；返回值：若写入成功，返回TRUE，否则返回FALSE。
无返回值 ShowLogSysDlg（）功能：显示日志系统用户界面。
参数：无。
返回值：无。
3.2 内部接口接口列表如下：BOOL InitAccessDB()功能：初始化数据库。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL CloseAccessDB()功能：关闭数据库。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL StoreIPAddr()功能：将登录过主系统的用户的IP写入下拉列表。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL StoreUserID()功能：将登录过主系统的用户的ID写入下拉列表。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL GetSoftwareLogChoices()功能：当用户对软件运行日志进行搜索时，获取用户选择的筛选条件。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL GetUserLogChoices()功能：当用户对用户日志进行搜索时，获取用户选择的筛选条件。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL InitComboBox()功能：对除用户ID及用户IP以外的下拉列表框进行初始化。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL InitColumn()功能：对列表控件进行初始化。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL ReadSoftwareLogFromDB(const char*)功能：将软件运行日志从数据库中读出。
参数：若需要读取存储系统，传入”StoreLog”，若需要读取云台系统，传入”CloudLog”，大小写不透明。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL ReadUserLogFromDB()功能：将用户日志从数据库中读出。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL InitImageList()功能：初始化图标列表。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL GetLastUser()功能：取得数据库中最后一个用户记录，作为当前系统的使用者。
参数：无。
返回值：若成功返回TRUE，否则返回FALSE。
BOOL OnSoftwareLogSearch()功能：搜索软件运行日志。
参数：无返回值：若成功返回TRUE，否则返回FALSE。
BOOL OnUserLogSearch()功能：搜索用户日志。
参数：无返回值：若成功返回TRUE，否则返回FALSE。
4 运行设计4.1 运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。
4.2 运行控制第一阶段实例化对象并初始化。
m_DB= new CDBAccess();实例化数据库对象：m_DB。
调用函数布尔值 Init()，初始化数据库m_DB对象。
布尔值 Connect(const TCHAR*Host,const TCHAR* User,const TCHAR* Password,const TCHAR* Database,DWORD Port)，连接数据库。
如果成功，第二阶段。
布尔值 initComboBox() ,初始化下拉列表字符串 GetChoices()，获取用户在筛选区中说要获取日志信息的条件。
布尔值 ReadUserLog(CString strSQL)，从数据库中获取用户所需要的用户日志布尔值 ReadLogisticsLog(CString strSQL)，从数据库中获取用户所需要的物流配送日志布尔值 ReadEmployeeLog(CString strSQL)，从数据库中获取用户所需要的员工信息日志布尔值 ReadEducationalLog(CString strSQL)，从数据库中获取用户所需要的教务系统信息日志布尔值 Close（），关闭数据库第三阶段：当整个系统退出时，调用布尔值ReleaseDB() 释放资源，退出系统。