注意：该文档为word文档，想要模板请回复关键字「概要设计说明书」。

某某系统

概要设计说明书

版本：[1.2]

北京象速蓝鲸科技有限公司

版权所有 侵权必究

某某系统

版本

密级

1.2

内部公开

共 页

拟 制

项目开发组

时 间

2020-11

审 核

时 间

批 准

时 间

修订记录

日期

修订版本

描述

2020-09-09

1.0

李鹏星

2020-09-28

1.1

增加统一资源管理平台部分设计

李鹏星

2020-10-07

1.2

增加师资平台部分设计

李鹏星

目 录

第一章引言

第二章参考

第三章术语

第四章任务概述

4.1 目标

4.2 运行环境

4.2.1 软件环境

4.2.2 硬件环境

4.2.3 硬件系统和基础软件系统资源列表

4.3 需求概述

4.4 条件与限制

第五章总体设计

5.1 总体结构

5.1.1 权限控制结构

5.1.2 接口数据流转

5.1.3 数据存储结构

第六章接口设计

6.1 外部接口

6.1.1 提供流量统计数据

6.1.2 给 络监控软件开放SNMP接口

6.1.3 同步组织部局级干部编 信息

第七章设计规划

7.1 系统门户设计

7.1.1 引言

7.1.2 参考

7.1.3 术语

7.1.4 任务概述

7.1.5 总体设计

7.1.6 接口设计

7.1.7 系统出错设计

7.1.8 附录

第一章引言

第二章参考

l 《投标文件》

l 《招标文件_20200429》

l 系统原型

第三章术语

l AICC、SCROM都是课件标准

l 外部：表示面向外 ，可通过internet访问

l 内部：不可通过internet访问，只供内部用户访问

第四章任务概述

4.1 目标

实现的目标是什么？

4.2 运行环境

4.2.1软件环境

统一用户管理系统总体软件架构采用基于J2EE技术的B/S架构来实现。

4.2.2 硬件环境

总体硬件拓扑图如下

4.2.3 硬件系统和基础软件系统资源列表

IP地址

服务器及

络设备

对外服

务端口

软件系统

域名

是否

对外

正式系统

.1

内部

备份服务器

内部

4.3 需求概述

白色部分为待建系统，蓝色为需要建立的系统

上图描述了本系统的功能分层图。

需求范围：

为满足学员不断增加、课件日益丰富、功能更加完善的需求。

（1）升级改造用户认证、学员管理、角色管理、信息发布、课件点播、 上考试、 上组班等功能

（2）。。。。。。。

用户范围：

4.4 条件与限制

? 本系统基于B/S运行结构，所以系统运行时除了能获得B/S架构的优势外，B/S架构所固有的与服务端交互的被动性也将显示出来。

第五章总体设计

下图为本系统核心功能的结构图，该图描述了系统的核心功能组成：（一些非主干功能的模块由于篇幅的限制没有在下图中绘制）

5.1 总体结构

为了明确的描述系统的总体结构图，本节将按照：权限控制结构、接口数据流转、数据存储结构三个层面对系统进行描述。

5.1.1 权限控制结构

本系统使用了SSO，在门户上保存用户登录的信息，并负责提供给各个需要这些信息的子系统。登录信息关联图如下所示

统一用户数据库保存了系统中所有的用户信息，机构信息，用户与机构的关系信息。此外，统一用户数据库中还包含了权限用户所受到的权限限制（子系统管理，子系统角色管理，角色下用户管理范围管理）。

5.1.2接口数据流转

本节着重描述的是业务数据在各个子系统的流转中涉及到的业务数据。统一用户数据的传输已经在上一节描述完成，所以在本节不在描述。

5.1.3数据存储结构

基本原则是多利用RAC Oracle数据库，这样能够高效统一的存储数据，包括能够较好的备份数据。对于数量多，容量大的课件、流媒体文件等数据，均采取文件存储方式。

第六章接口设计

6.1 外部接口

6.1.1 提供流量统计数据

给流量统计软件开放各个应用服务器的日志文件包（应用服务器记录外界访问的目录，文件均以.log结尾）。

对于Weblogic8服务器，开放对应目录的FTP功能，让流量统计软件能够访问。

对于IIS服务器，将该目录变成一个虚拟目录，让流量统计软件通过http的方式完成访问。

6.1.2给 络监控软件开放SNMP接口

所有系统中的Linux和Windows服务器均开放SNMP接口。

6.1.3同步组织部局级干部编 信息

通过excel文件的方式将组织部发来的局级干部编 信息导入到统一用户管理平台当中。

第七章设计规划

在本系统中涉及的子系统分为下述几类：

l 需要项目组重新开发的系统，如：统一用户管理系统，在线学习系统等

l 需要项目组集成的第三方产品，如：互动教室， 上 告厅等

l 需要项目组在此基础上定制开发的工具集成，如：润乾 表等

二期项目系统结构图按照一级系统、二级系统、三级系统的维度进行划分。

一级主系统（项目的主业务系统，需要保证有24小时持续工作能力的）为：

二级系统（项目中重要等级低一些的系统，）

三级系统（项目中部重要的系统，可以临时重新启动更新修改）

7.1 系统门户设计

7.1.1 引言

7.1.2参考

l 《门户 站系统需求规格 告》

l 门户系统原型

7.1.3术语

7.1.4任务概述

7.1.4.1 目标

门户管理平台（以下简称门户），可以将用户所需的各种应用和信息资源组合起来，为用户提供统一用户集成和访问多种信息的统一入口，简化各类用户对信息、应用的访问并实现个性化定制。可以方便访问业务信息、应用系统和服务信息。

门户将用户所有的应用和数据的展示集成到一个信息管理平台之上，并以统一的用户界面提供给用户。门户是基于Web的系统，它能向分布在各处的用户提供应用信息，帮助用户管理、组织和查询相关信息。用户只需要使用浏览器就可以得到自己需要的数据和信息。门户可以满足各类用户不断增长的需求，更有效地利用数据资源和信息资产。

7.1.4.2运行环境

? 软件环境

统一用户管理系统总体软件架构采用基于JAVA EE技术的B/S架构来实现，由于系统业务涉及用户、机构数据的交换，所以需要采用基于数据交换平台的运行环境来作为整个系统运行的一部分，其他基于如 表引擎，Web Services引擎，消息服务为可选部分，根据实际情况来选择，主要是为了考虑整个系统的可扩展性，可维护性等因素，以服务引擎的方式来支撑业务组件及其他组件来进行整体的设计考虑。

软件环境：

服务器端

操作系统：Redhat Linux AS 4.0

数据库：Oracle10g

应用服务器：WebLogic8.15

客户端

操作系统：Win XP

? 硬件环境

总体硬件拓扑图和硬件配置请参见《概要设计总册》

硬件环境

服务器端

DELL PE 6850

CPU：4、内存16G，硬盘：146G*2

客户端

普通PC

络环境

中心机房采用1000M光纤局域 ， 络出口速率为：50M

7.1.4.3需求概述

l 需求范围：

通过“门户管理平台”实现统一的信息集中展现和统一的办公导航功能。通过多种集成方式和手段（如portalet、iframe等模式）完成和各个业务系统的信息集成。门户系统集成的框图如下：

l 用户范围：

角色

职责

所属部门

各级领导干部学员

所有部门

在线学习中心管理人员

在线学习中心

区县组织部门管理人员

区县组织部

各市级单位组织管理人员

各市级单位组织

7.1.4.4条件与限制

? 本系统基于B/S运行结构，所以系统运行时除了能获得B/S架构的优势外，B/S架构所固有的与服务端交互的被动性也将显示出来。

? 统一用户与各个子系统的数据同步采用每天晚上自动定时增量同步和手工同步两种方式，这两种方式均有一定时间上面的延迟。所以在用户数据上面会产生

7.1.5总体设计

7.1.5.1 模块设计

? 首页

2 登录

2 修改密码

2 管理服务中心

该栏目是针对不同层级和权限的管理员用户提供的快捷功能链接。包括：培训班在线 名、干部培训档案管理、师资库、教学基地、资讯 送、建立班级园地、在线学习用户管理、在线学习统计查询、开办 上培训班、短信服务、移动学习服务。

2 通知通告

列出该栏目中最新发布的前八条通知，第一条为重要信息以红字显示。

2 资讯

列出该栏目中最新发布的前九条资讯。

2 动态数据

显示本系统当前的学习动态数据信息。包括：上线课件数量、注册学员人数、完成学时人数三项。

2 资讯 送排行

显示采用的各单位上 的资讯信息条数。

2 最新课件评论

显示学员在学习过程中对所学的课程发表的最新评论信息。

2 新课推荐

列出最近更新的九门推荐课件的封面图片。通过点击课件的封面图片或课件名称查看该课件的详细信息。

2 上周热门课件

展示上一周被学员选择学习最多的课件名称列表。

2 参考视频

2 政府决策

政府决策的信息。

2 最新班级

展示线下培训班的名称,登录后可以直接进入自己的班级园地。

2 博文热点

列出学员的博客文章信息。

2 在线答疑

在线答疑是对学员在本系统学习使用过程中出现问题后，系统维护人员对学员提供各种途径的解答。列表显示为“常见问题”解答的滚动信息列表。

? 决策参考

决策参考包括：政府决策支持系统和中经视频两部分信息内容。

? 帮助大全

点击“帮助大全”进入到帮助大全页面，左侧为功能区域导航栏，右侧对应显示左侧所选择导航栏的列表信息。默认显示常见问题及解决信息。

? 关于我们

? 页尾

包括相关 站的链接地址和本 站的相关信息，学员可以通过该功能进入更多的 站查看信息和联系方式信息，为学员提供更快更好的学习服务。

7.1.5.2 总体结构

下面我们通过总体功能结构图描述该系统的功能分配和流转：

7.1.5.3 包分配结构

包名

中文名称

描述

sso

单点登录包

单点登录相关相关的类

configuration

配置文件包

读取配置文件相关的类

7.1.6接口设计

7.1.6.1 用户界面

详细用户界面请参见《门户 站系统原型》原型部分。

7.1.6.2 外部接口

? 与同构系统完成SSO交互

通过https通道把加密的用户信息传输给有可信证书的子系统。

? 与互动教室完成SSO交互

将用户密码进行MD5加密之后传给互动教室完成登录，在互动教室中在线学习功能可以直接打开门户系统，并将密码MD5加密后传给门户自动进行登录操作

? 与参考资料完成SSO交互

在访问参考资料之前验证用户是否已经登录。如没有登录弹出登录框进行登录。在完成登录

后系统直接转向需要访问的站点。如果用户已经登录，直接跳转

7.1.6.3 内部接口

系统的关键配置文件如下：（详细使用说明见“系统安装与配置说明”，下表所说路径均在 站目录下）

文件用途

文件路径

说明

系统配置文件

WEB-INFclassesbjceconfig.xml

用于系统级的属性配置

Portal配置文件

WEB-INFclassesportalconfig.xml

Portal的详细连接地址配置

7.1.7 系统出错设计

本系统出错信息分为：

? 前台输入信息错误。

? 后台检验信息错误。

? 后台处理错误。

前台输入信息指用户在填写表单信息的时候出现的填写错误，如必填项没有填写，必须填写数字却填写字母，用户进行了一些禁止执行的功能或需要警示的功能。

后台检验信息错误指用户在提交请求或系统在后台执行处理的时候检查到用户信息错误。

后台处理错误指由于程序处理问题，或者由于系统硬环境问题导致后台处理发生错误，如程序本身的Bug或者由于 络问题导致数据库连接异常等。

l 出错输出信息

? 前台出错信息

前台必填项信息：

本系统使用JSValidation模块完成前台必填项信息输出，每个需要检查的页面配置独立的必填项检查配置文件，在用户提交 页的时候进行检查，将用户所有没有填写的必填项信息使用对话框的形式显示出来，并且使用橙色框将高亮显示需要填写的区域。

前台填写错误信息：

如果属于用户填写错误，系统使用alert()方式，弹出对话框，告知用户应当避免此操作。

? 后台检验信息

后台可识别的错误信息用Exception表示出来，并且输出到用户前台，并告知用户错误情况。后台的检验信息分为Struts范畴错误信息。

Struts范畴错误信息：

此类异常主要用于在功能性调用的环节下产生的异常。

异常类名称

常量值（resourceKey）

说明

? 后台处理错误

后台处理异常分为数据库连接异常，SQL语句异常等一系列运行期异常。这些运行期异常由系统统一捕获，写入Log文件，并且输出到页面。

l 出错处理对策

出错处理对策分为几个方面：

? 客户端输入错误；

? 后台程序检验错误；

? 产生未知错误。

针对上述3类错误，处理方式如下：

错误类型

处理方法

备注

客户端输入错误

使用JSValidation或JavaScript完成对用户的提醒

后台程序检验错误

后台程序进行捕捉，转换成确定的异常抛到页面，并记入日志

产生未知错误

后台程序进行捕捉，抛到页面，并记入日志

需要注意保证两个系统集成的时候的事务保证策略

对于后台产生的Exception，一般情况下都可以完成事务控制，但是如果存在两个或多个系统在API级别方面的集成，而API不提供统一事务机制，则会产生无事务问题，这时需要将主业务API放在前面调用，辅助且稳定的API放在后面调用。

对于后台的程序，严禁使用如下代码：

try{

}catch(Exception ex){

}

即catch中什么也不做，纯粹为了编译通过。

7.1.8附录

l 冗余字段使用情况记录

?