运行手册系统详细设计V1..doc

文件编号： 密级： 项目ID： 项目编号： 运行手册管理系统详细设计说明书拟制刘波日期2011/09/02审核日期批准日期声 明本文件所有权和解释权归Redhat和南方航空共同所有，未经书面许可，不得复制或向第三方公开。修订历史记录版本日期AMD修订者说明V0.12011-09-02刘波初稿（A-添加，M-修改，D-删除）目 录1. 目录2. 前言本文档为运行手册管理系统的详细设计文档，作为系统的开发的说明文件。2.1. 目的本文档为运行手册管理系统的详细设计说明，为系统的开发提供方案和说明。系统的开发必须符合本文档的相关描述说明2.2. 文档范围本文档包括：2.3. 术语与缩略词术语、缩略词解释2.4. 参考资料文档名称版本日期3. 设计前提和假设4. 系统总体说明4.1. 系统功能描述本系统为4.2. 非功能性描述；5. 功能结构 6. 功能设计6.1. 手册维护使用角色具有系统管理员及业务管理员权限的用户，才能增加、修改及查询功能。功能概述此模块主要提供手册基本信息、手册版本、手册类别、手册版本修订与发布、纸质手册、手册下发、手册跟踪等功能。用例描述流程描述6.1.1. 手册基本信息【使用角色】具有系统管理员和业务管理员权限的用户，才能增加、修改手册基本信息。【功能描述】此模块主要提供实现对手册基本信息的新增、修改、,删除、查询、查看等功能。【用例描述】6.1.1.1. 操作说明及参考界面6.1.1.1.1. 参考界面6.1.1.1.2. 功能操作及操作说明手册注册操作 用户在左边分类中单击选择分类，然后点击新增按钮，进入手册基本信息新增页面，用户输入手册基本信息的相关内容：手册编号，手册名称等基本信息后保存或者取消。属性修改操作 选中需要修改的手册基本信息列表，单击修改按钮，进入手册基本信息编辑页面，将修改后的数据保存。手册作废操作 选中要删除的手册基本信息记录，点击删除按钮，系统提示是否要删除，确定删除后及检查通过后资料会被彻底删除。查询操作 根据输入的查询条件如手册名称称进行查询，单击查询按钮，页面将显示满足该条件下的手册信息。6.1.1.1.3. 前后台对应关系- 页面路径：pages/manual/listManualInfo.jsp- 查询：点击后，调用 manual-ManualInfo-queryManualInfoPagebyAllCatalogLevel.action，查询手册基本信息- 手册注册：点击后，调用 manual-ManualInfo-addManualInfo.action，新增手册基本信息- 属性修改：点击后，调用 manual-ManualInfo-updateManualInfo.action， 实现保存编辑后信息，返回显示列表界面- 手册作废：点击后，调用manual-ManualInfo-deleteManualInfo.action， 实现信息删除后，返回显示列表界面- 作废手册查询：点击后，调用 manual-ManualInfo-queryManualInfoPagebyAllCatalogLevel.action，查询手册基本信息。6.1.1.2. 类和对象说明6.1.1.2.1. 包定义序号包路径说明1com.csair.dms.web.action.manual包含构型维护模块相关的action2com.csair.dms.manual包含构型维护模块相关的领域业务3com.csair.dms.application.manual包含构型维护模块相关的应用服务4webapp/page/manual/*.jsp包含构型维护模块相关的页面实现6.1.1.2.2. 类图和类说明【表现层类图】【应用和领域类图】【数据表与领域类关系图】6.1.1.2.3. 对象处理流程6.1.1.3. 模块接口6.1.1.3.1. 引用接口无6.1.1.3.2. 提供接口无6.1.1.4. 数据结构数据结构对应表说明ManualInfoML_MANUAL_INFO手册基本信息6.1.1.5. 数据库关系说明（E-R图）6.1.2. 手册版本【使用角色】具有系统管理员、业务管理员权限、普通用户可以查询、查看手册版本信息。【功能描述】此模块主要提供实现对手册版本的查询、查看等功能。【用例描述】6.1.2.1. 操作说明及参考界面6.1.2.1.1. 参考界面6.1.2.1.2. 功能操作及操作说明目录内容操作 选择需要查看的手册版本，点击目录内容按钮，查看该版本下得目录内容。纸质手册操作 选中需要查看的手册版本，点击纸质手册按钮，打开纸质手册查看列表。查询操作 根据输入的查询条件如手册名称称进行查询，单击查询按钮，页面将显示满足该条件下的手册信息。6.1.2.1.3. 前后台对应关系- 页面路径：pages/manual/listManualVersion.jsp- 查询：点击后，调用 manual-ManualVersion-queryManualVersionPage，查询手册版本信息- 目录内容操作：点击后，调用 manual-ManualInfo-queryManualInfoById.action和manual-DocCatalog-acquireDocCatalogTreeVo.action，显示手册信息和手册目录信息。 - 纸质手册操作：点击后，调用 manual-ManualVersion-queryManualCopyByVersionPage.action，显示纸质手册列表界面。6.1.2.2. 类和对象说明6.1.2.2.1. 包定义序号包路径说明1com.csair.dms.web.action.manual包含构型维护模块相关的action2com.csair.dms.manual包含构型维护模块相关的领域业务3com.csair.dms.application.manual包含构型维护模块相关的应用服务4webapp/page/manual/*.jsp包含构型维护模块相关的页面实现6.1.2.2.2. 类图和类说明【表现层类图】【应用和领域类图】【数据表与领域类关系图】6.1.2.2.3. 对象处理流程6.1.2.3. 模块接口6.1.2.3.1. 引用接口无6.1.2.3.2. 提供接口无6.1.2.4. 数据结构数据结构对应表说明ManualInfoML_MANUAL_INFO手册基本信息ManualVersionML_MANUAL_VERSION手册版本DocCatalogML_DOC_CATALOG文档目录6.1.2.5. 数据库关系说明（E-R图）6.1.3. 手册类别【使用角色】具有系统管理员和业务管理员权限的用户，才能增加、修改手册类别。普通用户可以查询、查看手册类别。【功能描述】此模块主要提供实现对手册类别的新增、修改、,删除、查询、查看等功能。【用例描述】6.1.3.1. 操作说明及参考界面6.1.3.1.1. 参考界面6.1.3.1.2. 功能操作及操作说明新增操作 用户点击新增按钮，进入手册分类新增页面，用户输入的相关内容：分类名称，级别等信息后保存或者取消。修改操作 选中需要修改的手册分类，单击修改按钮，进入手册分类编辑页面，将修改后的数据保存。删除操作 选中要删除的手册基本信息记录，点击删除按钮，系统提示是否要删除，确定删除后及检查通过后手册分类会被彻底删除。查询操作 根据输入的查询条件如手册分类名称称进行查询，单击查询按钮，页面将显示满足该条件下的手册分类信息。6.1.3.1.3. 前后台对应关系- 页面路径：pages/manual/listManualCatalog.jsp- 查询：点击后，调用 manual-ManualCatalog-queryManualCatalogPage.action，查询手册版本信息- 新增：点击后，调用 manual- ManualCatalog - addManualCatalog.action，新增手册版本信息- 修改：点击后，调用 manual- ManualCatalog - updateManualCatalog.action， 实现保存编辑后信息，返回显示列表界面- 删除：点击后，调用manual- ManualCatalog - deleteManualCatalog.action， 实现信息删除后，返回显示列表界面。6.1.3.2. 类和对象说明6.1.3.2.1. 包定义序号包路径说明1com.csair.dms.web.action.manual包含构型维护模块相关的action2com.csair.dms.manual包含构型维护模块相关的领域业务3com.csair.dms.application.manual包含构型维护模块相关的应用服务4webapp/page/manual/*.jsp包含构型维护模块相关的页面实现6.1.3.2.2. 类图和类说明【表现层类图】【应用和领域类图】【数据表与领域类关系图】6.1.3.2.3. 对象处理流程6.1.3.3. 模块接口6.1.3.3.1. 引用接口无6.1.3.3.2. 提供接口无6.1.3.4. 数据结构数据结构对应表说明ManualInfoML_MANUAL_INFO手册基本信息ManualCatalogML_MANUAL_CATALOG手册分类6.1.3.5. 数据库关系说明（E-R图）6.1.4. 手册修订与发布【使用角色】具有系统管理员和业务管理员权限的用户，才能增加、修改、删除、提交审核、发布版本修订。【功能描述】此模块主要提供实现对版本修订的增加、修改、删除、提交审核、发布、查询、查看等功能。【用例描述】6.1.4.1. 操作说明及参考界面6.1.4.1.1. 参考界面6.1.4.1.2. 功能操作及操作说明新增操作 用户点击新增按钮，进入版本修订新增页面，用户输入的相关内容：修订类型、修订人、版本号等信息后保存或者取消。修改操作 选中需要修改的版本修订，单击修改按钮，进入版本修订编辑页面，将修改后的数据保存。删除操作 选中要删除的版本修订记录，点击删除按钮，系统提示是否要删除，确定删除后及检查通过后版本修订会被彻底删除。提交审核操作 选中要提交审核的版本修订记录，点击提交审核按钮，系统提示是否要提交审核，确定后会修改版本修订状态并通知审核人处理。发布操作 选中要发布的版本修订记录，点击发布按钮，将本次修订发布到手册中，手册修订工作完成，开始进行下发操作。查询操作 根据输入的查询条件如手册名称、版本修订业务编号等进行查询，单击查询按钮，页面将显示满足该条件下的版本修订信息。6.1.4.1.3. 前后台对应关系- 页面路径：pages/manual/ listManualRevise.jsp- 查询：点击后，调用 manual- ManualRevise-queryManualRevisePage，查询版本修订信息- 新增：点击后，调用 manual- ManualRevise - addManualRevise.action，新增版本修订信息- 修改：点击后，调用 manual- ManualRevise updateManualRevise.action， 实现保存编辑后信息，返回显示列表界面- 提交审核：点击后，调用 manual- ManualRevise auditManualRevise.action， 实现提交审核，返回显示列表界面- 发布：点击后，调用 manual- ManualRevise reviseManualRevise.action， 实现发布版本修订，返回显示列表界面- 删除：点击后，调用manual- ManualRevise - deleteManualRevise.action， 实现信息删除后，返回显示列表界面。6.1.4.2. 类和对象说明6.1.4.2.1. 包定义序号包路径说明1com.csair.dms.web.action.manual包含构型维护模块相关的action2com.csair.dms.manual包含构型维护模块相关的领域业务3com.csair.dms.application.manual包含构型维护模块相关的应用服务4webapp/page/manual/*.jsp包含构型维护模块相关的页面实现6.1.4.2.2. 类图和类说明【表现层类图】【应用和领域类图】【数据表与领域类关系图】6.1.4.2.3. 对象处理流程6.1.4.3. 模块接口6.1.4.3.1. 引用接口无6.1.4.3.2. 提供接口无6.1.4.4. 数据结构数据结构对应表说明ManualReviseML_MANUAL_REVISE版本修订ManualReviseContentML_MANUAL_REVISE_CONTENT版本修订的内容6.1.4.5. 数据库关系说明（E-R图）6.1.5. 纸质手册【使用角色】具有系统管理员和业务管理员权限的用户，才能增加、删除、留用登记、使用登记、调拨纸质手册。【功能描述】此模块主要提供实现对纸质手册的增加、删除、留用登记、使用登记、调拨等功能。【用例描述】6.1.5.1. 操作说明及参考界面6.1.5.1.1. 参考界面6.1.5.1.2. 功能操作及操作说明新增操作 用户点击新增按钮，进入纸质手册新增页面，用户输入的相关内容：基地、手册类型、数量等信息后保存或者取消。删除操作 选中要删除的纸质手册记录，点击删除按钮，系统提示是否要删除，确定删除后及检查通过后纸质手册会被彻底删除。留用登记操作 选中要留用的纸质手册记录，点击留用登记按钮，进入留用登记修改页面，确定后会修改纸质手册的管理人、管理部门等。使用修改操作 选中需要修改的纸质手册，单击修改按钮，进入纸质手册编辑页面，将修改后使用人、使用部门等信息保存。调拨操作 选中要调拨的纸质手册记录，点击调拨按钮，将纸质手册调拨到另一单位。查询操作 根据输入的查询条件如手册名称、控制号等进行查询，单击查询按钮，页面将显示满足该条件下的纸质手册信息。6.1.5.1.3. 前后台对应关系- 页面路径：pages/manual/ listManualCopy.jsp- 查询：点击后，调用 manual-ManualCopy-queryManualCopyPage，查询纸质手册信息- 新增：点击后，调用 manual-ManualCopy- bulkManualCopy.action，新增纸质手册信息- 删除：点击后，调用manual-ManualCopy-deleteManualCopy.action， 实现信息删除后，返回显示列表界面。