TopTools下的PssAdmin系统－概要设计

CJTPADS概要设计 1/15 TopTools-PssAdminTopTools-PssAdmin 概要设计概要设计 CJTPADS概要设计 2/15 文档信息文档信息 作者陈振荣 创建日期2008-3-20 版本1.0 部门名称系统支援部 修修订订文档文档历历史史记录记录 日期日期版本版本说说明明作者作者 2008-03-201.0陈振荣 2008-05-121.1新添导入，导出的功能陈振荣 CJTPADS概要设计 3/15 目录目录 1.介介绍绍 .1 1.1目的目的1 1.2文档文档协协定定1 1.3阅读阅读者建者建议议1 1.4参考参考1 2.系系统层统层次架构（次架构（STRUCTURE） ）设计设计1 2.1聊天功能框架聊天功能框架图图1 2.2导导入入导导出功能框架出功能框架图图2 2.3XML Editor 功能框架功能框架图图 3 3.接口接口设计设计3 3.1界面界面设计设计3 3.1.1GUI-0001 .3 3.1.2GUI-0002.4 3.1.3GUI-0003.8 3.1.4GUI-0004.9 3.1.5GUI-0005.10 4.应应用用逻辑设计逻辑设计.11 4.1概念模型概念模型设计设计11 4.2Service 设计设计 .11 5.存存储设计储设计12 5.1数据数据库设计库设计12 5.1.1聊天记录库（HYK）.12 5.2其它存其它存储设计储设计12 概要设计文档 1/15 1. 介介绍绍 1.1 目的目的 概要设计是对需求分析中涉及到的需求，分配到各个小的系统或者组件中去，并且定义这些 组件的接口，以方便开发者按照这些接口进行相应的需求实现。 1.2 文档文档协协定定 本文档的书写遵循公司定义的文档规范，并且定义如下协定： ConventionDescriptionDemo 粗体标题或者字段 B 粗斜体重要信息，需要注意 BI 蓝色字体需要确认 Blue 斜体使用方法说明 I 1.3 阅读阅读者建者建议议 本文档建议阅读者为详细设计和代码开发人员 1.4 参考参考 2. 系系统层统层次架构（次架构（Structure） ）设计设计 2.1 聊天功能框架聊天功能框架图图 概要设计文档 2/15 PMS 系系统统 ChatClient 功能功能 其他功能其他功能 PSS 系系统统PssAdmin 系系统统 ChatClient 功能功能 其他功能其他功能 ChatServer 服服务务 其他服其他服务务 发送消息 接收消息 发送消息 接收消息 说说明：明： 1.系统采用 BS 架构：服务端，客户端。 2.服务端处理消息发送的逻辑。 3.客户端有个界面用于接收消息。 2.2 导导入入导导出功能框架出功能框架图图 PssAdmin 系系统统Pss 系系统统数据数据库库 导导入功能入功能消息消息处处理理 发发送消息送消息 参数数据参数数据 导导入数据入数据 消息消息处处理理参数数据参数数据 导导出数据出数据参数数据参数数据 导导出功能出功能 概要设计文档 3/15 说说明：明： 1. 导入的数据会覆盖原数据库中的数据，所以导入数据要小心。 2. 导入导出的功能在 PMS 系统中就有的，为了便于 PssAdmin 系统的管理，也要在 PssAdmin 系统中增加导入导出的功能，所增加的导入导出功能与原 PMS 的导入导出功能类似，只是会 将导入导出功能整合到一个模块中（在 PMS 中，导入导出功能是不同的模块），还会增加一个 “恢复到某个恢复到某个时间时间点的功能点的功能”。 。 3. 导出数据是将数据库中的数据拿出，储存到硬盘上的一项功能，有利于保存历史的数据， 避免当数据库中的数据破坏时无法恢复。 2.3 XML Editor 功能框架功能框架图图 说说明：明： 1、 pss_help.xml 文件是 pss.xml 文件的一个扩充，pss_help.xml 文件里的每个元素与 pss.xml 文件里的元素一样，只是在 pss_help.xml 文件里，每个元素都有 desc,enum,help 三个子元 素。 2、 XML Editor 会读 pss.xml 与 pss_help.xml 文件，然后用 pss.xml 文件形成一棵树,而对树的 操作，如：增加新的子节点，会相应修改 pss.xml 与 pss_help.xml 文件。 3. 接口接口设计设计 3.1 界面界面设计设计 3.1.13.1.1 GUI-0001GUI-0001 界面编号：GUI-0001 PSS 系系统统PssAdmin 系系统统 pss.xml 文件文件 pss_help.xml 文件文件 XML Editor 功能功能 读进 读进 修改 修改 概要设计文档 4/15 名称：聊天客户端界面 界面图形：（真实界面的设计截图） 说明 1、聊天可以分为：广播，私聊，多人聊；广播所有在线用户都可以收到消息；私聊是只 有进行聊天的两个人收到消息，其他人收不到； 多人聊就是可以有多个用户同时进 行聊天，收到消息的只是聊天的这几人。 2、广播可以直接在消息发送框中输入消息，然后点击发送；私聊要用鼠标左键点选要 发送消息的用户，然后在消息发送框中输入消息，点击发送；多人聊先按住”Ctrl”键， 然后用鼠标左键点选要发送消息的用户，输入消息，点击发送。 3、广播消息用红色表示；发送消息用蓝色表示；接收消息用绿色表示。 概要设计文档 5/15 3.1.2 GUI-0002 界面编号： GUI-0002 名称：XML Editor 界面 界面图形：（真实界面的设计截图） （图1） 概要设计文档 6/15 （图2） 概要设计文档 7/15 （图3） 说明 1.点击树上的某个节点时会动态弹出该节点的详细信息，如： Path,Name,Value,desc,help。详细信息的说明如下： Path:节点在pss.xml文件中的路径 Name:节点在pss.xml文件中的名字 Value:根据节点在pss_help.xml文件中的子元素enum的flag属性的值，如果 flag=”Y”,则Value用下来框显示所有的可选项，如图1；否则用文本框显 示节点 的值如图2 desc:节点在pss_help.xml文件中的子元素desc的值 概要设计文档 8/15 help:节点在pss_help.xml文件中的子元素help的值 2.对节点点击右键会弹出菜单，可以对节点进行相应的操作如图3 3.刚打开XML Editor时，节点详细信息及源码的区域是不可编辑的，只有按下 “Edit”按钮，Name的文本框，Value的文本框，源码的区域才可以编辑。 4.只有按下“Save”按钮所有的更改才会写到XML文件 3.1.3 GUI-0003 界面编号：GUI-0003 名称：参数数据导入界面 导入界面的设计位置（还未实现，只是设计） Import and Export System ParamDataImportImport 档案参数数据导入 历史内容查看 文档树 请选中日记文件名称 界面图形：（真实界面的设计截图） 确 认 取 消 帮 助 概要设计文档 9/15 说明 1.只能导入日记文件； 2.导入数据后会覆盖数据库中的数据，所以导入之前要注意。 3.导入界面的设计位置是要将导入与导出的功能结合起来后导入功能要放置 的位置。 3.1.4 GUI-0004 界面编号：GUI-0004 名称：param 数据导出界面 界面图形：（真实界面的设计截图） 概要设计文档 10/15 说明 1.导出参数的树据类型可以有:fch,tcp 等参数。 3.1.5 GUI-0005 界面编号：GUI-0005 名称：data 数据导出界面 界面图形：（真实界面的设计截图） 概要设计文档 11/15 说明 1. 只可以导出 FCH 类型的数据。 4. 应应用用逻辑设计逻辑设计 4.1 概念模型概念模型设计设计 4.2 Service 设计设计 5. 存存储设计储设计 5.1 数据数据库设计库设计 说明：表示主键，表示外键关联 5.1.1 聊天聊天记录库记录库（ （HYK） ） TimeSend Message User Receive Message User Message Type Content DATE VARCHAR(20) VARCHAR(20)VARCHAR(1) VARCHAR(500) 20080417 14:20:20ACC2adminCMD_LOGIN 20080417 14:20:30ACC2adminCMD_MESGhello 20080417 14:20:40ACC2CMD_BCASThello 20080417 14:20:50ACC2CMD_QUIT 说明：