JZ-SPI-E-TS-T05(详细设计说明书)

编码：编码：JZ-SPI-E-TS-T05镇江市金舟软件有限责任公司镇江市金舟软件有限责任公司 项目名称项目名称 详细设计说明书详细设计说明书拟制人拟制人 卢卢超超 日期日期 20062006 年年 0505 月月 2828 日日审核人审核人 日期日期 20062006 年年 0505 月月 2828 日日批准人批准人 日期日期 20062006 年年 0505 月月 2828 日日 详细设计说明书编码：JZ-SPI-E-TS-T05更改控制页更改控制页序号序号版本号版本号更改时间更改时间更改内容描述更改内容描述填写人填写人1102005-05-28建立卢超 详细设计说明书编码：JZ-SPI-E-TS-T05 目目 录录1引言.11.1编写目的.11.2编写背景.11.2.1系统名称及版本号 .11.2.2任务提出者 .11.2.3任务承接者及实施者 .11.2.4使用者 .11.2.5与其它子系统的关系 .11.3文档概述.21.3.1文档结构说明 .21.3.2电子文档编写工具 .21.3.3定义说明与符号 .21.3.4参考资料 .22功能概述.22.1功能模块命名原则.22.2功能层次图.22.3功能模块与部门的对应关系.42.4本子系统的外部接口.43数据库设计.53.1代码表列表.53.2实体集列表.53.3实体与表之间的对应关系.53.4物理数据模型图.63.5表属性描述.83.6数据量分布.93.7数据存储与访问分析.93.8安全保密措施.94功能模块详述.104.1模块 1.104.2模块 2.134.3模块 3.13 详细设计说明书编码：JZ-SPI-E-TS-T05 第 1 页1 1引言引言1.11.1 编写目的编写目的【说明】设计对象：系统的某个子系统。原则上，每个子系统的详细设计应单独装订成册； 但对于比较小的子系统，容许合并成一册。 预期读者：我公司与用户方的开发人员、双方的系统维护人员。 作用：承上启下。基于概要设计，为下一阶段的程序编码工作提供依据。它是项 目验收的重要内容和后期维护的必备资料。1.21.2 编写背景编写背景1.2.11.2.1系统名称及版本号系统名称及版本号【说明】形如“北京市地方税务局管理信息系统申报征收子系统 V3.0”。其中，版本号的格式为“XX.XX”，X 为阿拉伯数字，左“0”可省略。1.2.21.2.2任务提出者任务提出者【说明】指承担质量保证计划中规定的我方领导机构或项目负责人。1.2.31.2.3任务承接者及实施者任务承接者及实施者【说明】指承担本子系统详细设计的负责人及工作人员名单。1.2.41.2.4使用者使用者【说明】主要指预期读者，也供有关领导审阅。1.2.51.2.5与其它子系统的关系与其它子系统的关系【说明】给本子系统在整个系统中准确定位，用功能层次图及相应的文字予以说明。 详细设计说明书编码：JZ-SPI-E-TS-T05 第 2 页1.31.3 文档概述文档概述1.3.11.3.1文档结构说明文档结构说明【说明】章节划分原则、内容的取舍、重点的确定等。1.3.21.3.2电子文档编写工具电子文档编写工具【说明】工具名、版本号、操作系统平台。使用多种工具时，应分别说明。形如：Microsoft Office2003Power Designer 9.5Visio20031.3.31.3.3定义说明与符号定义说明与符号【说明】包括对专用术语及缩略语的解释、所用到的图（物理数据模型图/功能层次图/逻辑框图/流程图等）中图符的表示与解释、屏幕界面中图标与按钮的表示与含义等。 1.3.41.3.4参考资料参考资料【说明】格式：作者，版本号，资料来源，日期，起止页号。其中，需求规格说明书与概要设计说明书是必选的参考资料。2 2功能概述功能概述2.12.1 功能模块命名原则功能模块命名原则【说明】名字（即标识符）：一般采用英文或汉语拼音。要求有实际意义、便于理解、最好有规律可循。参看概要设计说明书并注意与之保持一致。2.22.2 功能层次图功能层次图【说明】自顶向下，逐层分解，直至叶（即末端）功能模块。 在每个子系统中，功能模块的编号是唯一的。推荐的编号原则为： 子系统(第 0 层)无编号 详细设计说明书编码：JZ-SPI-E-TS-T05 第 3 页 第 1 层子模块X 第 2 层子模块XX 第 3 层子模块XXX 第 4 层子模块XXXX 其中，X 可为阿拉伯数字 1-9（不许出现 0），或大写英文字母 A-Z（对应于 10-35），或小写英文字母 a-z（对应于 36-61）。必要时还可用希腊字母接续。例如：“6”表示本子系统中编号为 6 的第 1 层子模块。“63”表示在编号为 6 的第 1 层子模块下，编号为 3 的第 2 层子模块。“63B”表示在编号为 6 的第 1 层子模块下，编号为 3 的第 2 层子模块下，编号为 11 的第 3 层子模块。以下类推。这种编号原则的优点是模块编号比较短。如果使用形如“6.3.11”的形式还容易与相同形式的标题编号混淆。为顾及用户的习惯，我们也容许使用形如“6.3.11”的模块编号形式 详细设计说明书编码：JZ-SPI-E-TS-T05 第 4 页功能模块图的格式举例：第一层子模块还可以再继续分解。如编号为 3 的子模块可分解为：2.32.3 功能模块与部门的对应关系功能模块与部门的对应关系【说明】使用矩阵方式，说明用户单位的各个部门使用功能模块的情况。“”表示使用了该模块，“ ”表示未使用。其中的模块名可以是任意层次上的，最好与实际安装相对应。形如：模块 1模块 2模块 3模块 N部门 1部门 2部门 3部门 M2.42.4 本子系统的外部接口本子系统的外部接口【说明】与其它子系统的接口：数据/参数的调用/返回情况。 对特殊外部设备的需求：如扫描仪、数字化仪、条码设备、磁卡设备、票据打印机、调制解调器等。计划管理子系统2分单位计划分配3计划查询3计划查询31单项查询32组合查询323显示结果322快速检索321表达式处理4计划报表1分税种计划分配 详细设计说明书编码：JZ-SPI-E-TS-T05 第 5 页 这里应对各个接口（含数据接口与功能接口）逐一详细说明。3 3数据库设计数据库设计3.13.1 代码表列表代码表列表【说明】参看概要设计说明书。指出本子系统使用的代码表的列表。形如：代码表列表代码表名称中文注释中文注释里应确定该代码表在本子系统中的位置（公用/专用）。还应指明描述代码数据的文档名称与文档编号。3.23.2 实体集列表实体集列表【说明】分为系统公用实体列表与本子系统专用实体列表两类,源于概要设计。形如： 子系统公用实体列表实体名称中文注释 子系统专用实体列表实体名称中文注释3.33.3 实体与表之间的对应关系实体与表之间的对应关系【说明】概念对象实体（Entity）对应的物理对象为表（Table）。 实体属性（Entity attribute）对应的是表的列（Table column）。 标识符（Identifier）对应的是主键或外键（Foreign Key/ Primary Key, 取决是独立还是依赖关系）。 关系（Relationship）对应的是参照（Refrence）。 详细设计说明书编码：JZ-SPI-E-TS-T05 第 6 页 实体与表二者之间的对应关系，用表格简述如下：实体名称表名称说明3.43.4 物理数据模型图物理数据模型图【说明】物理数据模型即 PDM（Physical Data Model）。它详细说明了数据库的物理实现。在这里，我们将具体考虑物理实现的细节，包括数据的存储结构。可以通过修改 PDM 来适应性能/物理上的约束。 PDM 的主要作用是：以图形方式描绘出数据的物理组织结构；进行数据库的创建和修改；定义参照完整性；生成扩展属性；可以通过逆向工程重新产生 CDM(Conceptual Data Model)。 建议使用 Power Designer 9.0（或更高版本）绘制，应该保持 PDM 与相应 CDM 在逻辑上的一致性。具体要求可参看概要设计说明书中的有关内容。 这里特别值得注意的是：Power-Designer 可以使用脚本和通过 ODBC 驱动来创建和修改数据库。如果在实际过程中实施了这个步骤，应在详细设计说明书里有所反映。 详细设计说明书编码：JZ-SPI-E-TS-T05 第 7 页项目管理表关系图项目管理表关系图 r e% y e r e r r r r e r r l t l n 2 6 详细设计说明书编码：JZ-SPI-E-TS-T05 第 8 页 3.53.5 表属性描述表属性描述【说明】本子系统专用的表描述。可以采取两种方式： 表格+文字描述（推荐） 建表文件 表格形如：列名中文注释类型最大长度值域可否为空是否主键是否外键备注使用建表文件时，其内容应涵盖上表中的各项。无论采取哪种方式，都必须说明：索引表达式与索引文件（如果存在）、参照的定义与完整性保证。对重要的列，应补充说明其含义与使用须知。对于视图的描述，可类比进行。 详细设计说明书编码：JZ-SPI-E-TS-T05 第 9 页3.63.6 数据量分布数据量分布【说明】使用表格+文字的方式描述。形如：表名记录长（字节）最大记录数最大字节数 总字节数=各表最大字节数之和。 预计字节数=总字节数占空系数 其中，占空系数表示实际开销与理论开销之比。其比值可根据具体项目及运行环境而定，如可取1.5 至 2.5。 3.73.7 数据存储与访问分析数据存储与访问分析【说明】采用表格方式，应与数据量分布表对应。形如：存放位置表名保存期限（天）本站点局域网服务器广域网服务器访问方式访问方式如：只读、读写3.83.8 安全保密措施安全保密措施【说明】进行角色定义，说明各类角色的权限； 备份（包括安全性备份与历史备份）的要求与操作步骤； 日志文件的使用情况； 解决“千年虫”问题的办法； 防治计算机病毒的措施等。 详细设计说明书编码：JZ-SPI-E-TS-T05 第 10页4 4功能模块详述功能模块详述4.14.1 模块模块 1 1子系统名称业务子系统设计者设计日期2000/11/30模块名称处理名称申请登记处理编号前置条件前置条件约束条件约束条件输入（数据库表和关键字段）输入（数据库表和关键字段）处理过程详细描述处理过程详细描述 详细设计说明书编码：JZ-SPI-E-TS-T05 第 11页输出（数据库表和关键字段）输出（数据库表和关键字段）关键算法与核心代码关键算法与核心代码 详细设计说明书编码：JZ-SPI-E-TS-T05 第 12页异常情况处理异常情况处理后置条件后置条件 详细设计说明书编码：JZ-SPI-E-TS-T05 第 13页4.24.2 模块模块 2 24.34.3 模块模块 3 3