综合电信网管框架系统概要设计说明书.doc

综合电信网管框架系统概要设计说明书 v1.0综合电信网管框架系统概要设计说明书版本：1.0文件编号：AON_003版本号：1.0作者：谢鸿伟生成日期：2006-11-9总页数正文附录中兴软件南昌大学实验室目录1介绍(Introduction)21.1目的(Purpose)21.2范围(Scope)21.3文档约定(Standard of Documents)21.4预期的读者和阅读建议(Expected Reader & Reading Advice)21.5参考文档(Reference)22总体设计(Total Design)22.1需求描述22.2运行环境62.3基本设计与处理流程63接口设计(Ports-settings)123.1用户接口123.2外部接口123.3内部接口124运行设计(Running Design)134.1运行模块组合设计134.2运行控制134.3运行时间描述135系统数据结构设计(Structure Design of System Data)135.1系统数据结构设计135.2物理结构设计要点135.3数据结构与程序的关联136系统错误处理设计(Error Process Design)136.1错误信息136.2补救信息146.3系统维护设计141 介绍(Introduction)1.1 目的(Purpose)为充分描述综合电信网管框架系统软件的体系结构，制订本文档。本文档为后续软件需求（OA）的开发提供基础与约束。1.2 范围(Scope)本文档从面向对象的角度描述了综合电信网管框架系统的系统用例模型和系统的动态模型，包括系统用户的用例图、和系统整体活动图、系统登陆活动图、系统整体时序图、系统登陆时序图、管理员管理用户管理时序图、用户修改密码时序图及类图、接口等.1.3 文档约定(Standard of Documents)采用标准的文档书写约定，章标题使用粗体的小四号宋体，小节标题采用粗体的五号字体，正文采用正常的五号宋体。术语解释时术语部分加以下划线表示。1.4 预期的读者和阅读建议(Expected Reader & Reading Advice)读者分类目的系统分析人员根据产品规格需求分析系统需求，设计产品的体系结构系统设计人员理解产品体系结构，在设计时把握模块间的关系系统测试人员了解产品体系结构测试提供参考文档人员编写用户使用和操作手册1.5 参考文档(Reference)2 总体设计(Total Design) 2.1 需求描述 1.1. 登录输入：用户名与密码输出：显示软件主界面或提示错误信息过程：从桌面快捷方式程序中启动软件或通过软件的注销用户功能，弹出用户名与密码输入框，输入后回车或按确定。通过用户管理组件判断用户名与密码是否有效，进入软件或提示错误信息（如无法连接用户管理数据库、用户名密码错误等）。1.2. 加载并调用用户管理组件输入：无输出：在目录栏及树窗口中显示用户管理菜单。过程：用户管理组件作为默认组件在软件启动后被加载，调用其验证功能判断用户当前操作是否合法。备注：组件菜单插入在与菜单之间，功能树在之下1.3. 界面语言国际化输入：默认启动或在配置项中修改软件语言输出：软件所有菜单显示为用户所需要的语言过程：启动后读取软件配置文件，根据其中的默认语言项，加载框架与组件的相应语言配置文件。如果组件无相应语言，则组件单独按其默认语言显示。1.4. 动态加载模块输入：无输出：启动后在目录栏及树窗口显示已加载的组件菜单。过程：启动软件后，根据主程序目录下的组件包文件夹动态加载其组件功能。1.5. 用户管理所有的组件应用权限统一管理于一套用户管理制度。不同的用户单独存在或隶属于某用户组，当前组成员应用继承其所在组所有功能，并可更一步增加细化。通过用户管理组件，管理员可对用户组或用户进行增删和权限修改。所有用户都可使用其中的修改密码功能。1.5.1. 增加用户组输入：要增加的组名及组权限输出：提示成功或显示错误信息（如数据库连接错误、组名已存在等）过程：通过菜单栏或树窗口用户管理下进入用户组管理界面，选择按钮进入增加用户组界面，输入组名与权限后，确认提交备注：该功能只有管理员组才能使用1.5.2. 编辑用户组输入：要编辑的组ID及新组信息输出：提示成功或显示错误信息（如数据库连接错误、组名已存在等）过程：通过菜单栏或树窗口用户管理下进入用户组管理界面，选择用户组后点击按钮进入编辑用户组界面，组属性进行编辑后确认提交备注：该功能只有管理员组才能使用1.5.3. 删除用户组输入：要删除的组ID输出：提示成功或显示错误信息（如数据库连接错误、选择组不可删除等）过程：通过菜单栏或树窗口用户管理下进入用户组管理界面，选择用户组后点击按钮，确认删除备注：该功能只有管理员组才能使用、且管理员组不可删除，用户组删除后其下用户失去所有继承权限1.5.4. 锁定用户组输入：要锁定的组ID输出：提示成功或显示错误信息（如数据库连接错误、选择组不可锁定等）过程：通过菜单栏或树窗口用户管理下进入用户组管理界面，选择用户组后点击按钮，确认锁定。备注：该功能只有管理员组才能使用、且管理员组不可锁定，用户组被锁定后下属用户不能再登录软件1.5.5. 增加用户输入：要增加的新用户名称密码及权限输出：提示成功或显示错误信息（如数据库连接错误、用户名已存在等）过程：通过菜单栏或树窗口用户管理下进入用户管理界面，点击按钮，输入用户名，选择所属组后确定。也可建立不属于任何组的用户，权限独立控制备注：该功能只有管理员组才能使用，对权限修改时不能去除其用户所继承的权限。1.5.6. 编辑用户输入：要编辑的用户ID，及新用户信息输出：提示成功或显示错误信息（如数据库连接错误、用户名已存在等）过程：通过菜单栏或树窗口用户管理下进入用户管理界面，从用户列表中选择要修改的用户，点击按钮，修改用户属性后，确定保存备注：该功能只有管理员组才能使用，对权限修改时不能去除其用户所继承的权限。1.5.7. 删除用户输入：要删除的用户ID输出：提示成功或显示错误信息（如数据库连接错误、用户名不允许删除等）过程：通过菜单栏或树窗口用户管理下进入用户管理界面，从用户列表中选择要删除的用户，点击按钮，确认提交备注：该功能只有管理员组才能使用，且不能删除administrator用户1.5.8. 修改密码输入：要修改的用户ID，原密码，新密码输出：提示成功或显示错误信息（如数据库连接错误、原密码验证错误等）过程：通过菜单栏或树窗口用户管理下的进入密码修改界面，输入原密码及二次输入新密码后确认提交1.5.9. 日志记录输入：上一步操作的时间、执行者、用户、状态输出：在日志栏显示操作并记录入本地XML文件过程：1.5.10. 查看日志输入：无输出：显示本机操作的所有日志过程：通过菜单下的或工具栏上的快捷图标打开日志浏览窗口1.5.11. 软件设置输入：新设置属性输出：界面相应改变过程：通过菜单下的进入软件选项管理页面，可修改语言、快捷工具栏、历史窗口显示数目、启动时树菜单展开/叠起状态等配置项1.5.12. 关闭当前窗口输入：输出：当前窗口关闭过程：通过菜单栏下的或工具条上的按钮关闭当前窗口备注：当前无激活窗口时该选项为不可选1.5.13. 关闭所有窗口输入：输出：所有窗口关闭过程：通过菜单栏下的或工具条上的按钮关闭所有窗口备注：当前无打开窗口时该选项为不可选1.5.14. 关闭当前树结点输入：输出：当前树结点关闭过程：通过菜单栏下的或工具条上的按钮关闭当前树备注：当前结点已处于关闭状态时选项为不可选1.5.15. 关闭所有树结点输入：输出：所有树结点关闭过程：通过菜单栏下的或工具条上的按钮关闭所有树备注：当所有结点已处于关闭状态时选项为不可选1.5.16. 记录历史窗口输入：输出：在菜单下显示最近的若干历史窗口标题过程：在菜单下显示最近的若干历史窗口标题（默认5个），可点击激活或打开该窗口1.5.17. 主题帮助输入：输出：显示本系统的帮助文档过程：通过菜单栏下的或工具栏上的相应按钮打开帮助文档1.5.18. 组件帮助输入：输出：显示指定组件的帮助文档过程：通过菜单栏下的打开相应的组件帮助文档1.5.19. 软件声明输入：输出：显示本系统的软件声明过程：通过菜单栏下的打开软件声明备注：软件声明包含软件开发者、版本号、发布时间、版权声名、公司链接等信息，可通过点击公司链接打开系统默认浏览器访问公司网站，且该调用在各种操作系统上应均可实现。1.5.20. 树菜单控制输入：输出：以树形方式显示本系统及相应组件可提供的功能过程：备注：该树由所加载的组件不同而动态生成，对其中的功能可展开和折叠1.5.21. MDI窗口显示输入：输出：多个应用窗口同时在软件框架内显示过程：备注：新打开的应用应最大化显示，每一个应用只能打开一个窗口1.5.22. 状态条输入：输出：软件底部状态条显示当前登录用户、当前时间过程：2.2 运行环境 操作系统：Microsoft Windows 2000 Advanced Server或更高版本，Linux支持环境：JRE 1.42或更高版本数 据 库：MySQL 4.0或更高版本2.3 基本设计与处理流程 本系统包括组件管理、配置管理、日志管理、窗口管理、帮助这五大基本部分，用户管理作为其自带必需组件，以实现登录及对组件功能使用的权限控制。最高用例图如下用户通过登录后启动软件，通过组件管理实现各种业务（其自带用户管理组），通过管理设置组件加载、语言、用户界面等，通过日志管理保存软件操作记录、窗口管理实现组件窗口排列，帮助等。软件启动后，先在程序文件夹下读取aon.xml配置文件初始化配置，包括界面语言、不需要加载的组件等。然后遍历当前目录下的文件，发现组件后判断是否需要，对其进行加载。至此软件加载完成，显示登录窗口，登录成功后显示主窗体。所有操作活动及状态都可能被记录，以作为今后参考，日志记录活动图如下：2. 总体设计结构本系统为一个软件框架，通过加载业务组件来实现各种业务功能，其本身仅起到加载与管理业务组件、及日志记录的作用。下图为本框架大纲类图组件类图如下根据组件类图实例化的告警组件类图如下，本组件仅起示例作用2.4 功能需求与程序的关联度描述功能需求与程序的关联度。2.5 其他描述尚未解决的问题。3 接口设计(Ports-settings)3.1 用户接口功能组件放置于框架软件所有目录的plugins文件夹下，文件夹名为组件类名3.2 外部接口 ？3.3 内部接口 所有的组件应实现Controller接口所有的组件功能模块窗体继承ModuleFrame类所有的组件国际化类继承International类4 运行设计(Running Design)4.1 运行模块组合设计框架启动后遍历其plugins目录下的所有文件夹，将文件夹名作为组件类名保存。通过循环生成所有组件的实例，通过组件实例获得所有子功能模块类名，通过该类名可实例化子功能模块完成业务功能。4.2 运行控制描述运行控制相关内容。4.3 运行时间描述描述运行设计时间。5 系统数据结构设计(Structure Design of System Data)5.1 系统数据结构设计描述系统数据结构设计。5.2 物理结构设计要点 描述物理结构设计要点。5.3 数据结构与程序的关联 描述数据结构与程序的关联。6 系统错误处理设计(Error Process Design)6.1 错误信息6.1.1 主框架配置加载失败6.1.2 主框架指定语言加载失败6.1.3 框架配置加载失败6.1.4 框架指定语言配置加载失败6.2 补救信息 6.2.1 中断启动6.2.2 尝试加载默认语言，再次失败后中断启动6.2.3 跳过出错框架启动6.2.4 尝试加载默认组件语言，再次失败后中断启动6.3 系统维护设计6.3.1 业务功能扩展方法：开发相应的功能组件并添加到框架所在目录plugins文件夹下6.3.2 添加组件方法：将要添加的组件文件夹复制至框