第1页 / 共13页
第2页 / 共13页
第3页 / 共13页
第4页 / 共13页
第5页 / 共13页
第6页 / 共13页
第7页 / 共13页
第8页 / 共13页
接口开发文档-设计通用化.doc
1.编制目的
2.适用范围
3.文件说明
1.概述
1.1软件产品名称和版本
1.2模块名称、版本和编号
1.3模块的表现形式
1.4模块功能概述
1.5模块实现方式
2.接口设计
2.1人机界面设计
2.2软件接口设计
2.3外部软件接口
2.4外部硬件接口
3.数据库设计
3.1业务数据定义表（BUSI_TABLE_DEF_T）
3.2业务数据表字段定义表（BUSI_TABLE_FIELD_DEF_T）
3.3档案类型表（ARCHIVETYPE_T）
3.4 文档类型表（DOCUMENTTYPE_T）
4.数据设计
4.1全局静态数据
4.2全局动态数据
4.3临时存储数据
4.4永久存储数据
5.过程设计
5.1子功能划分
5.2算法设计
5.3流程设计
5.4过程实现
6.代码组织
6.1源代码组织结构
6.2编译方式
6.3源代码文件说明
详细设计说明书编写指南
详细设计说明书编写指南
文件编号：SJ-13-17
版次：1.0
修改状态：正常
最新发布日期： 2003-08-01
1. 编制目的
本文提出了详细设计说明书的编写要求，用以统一和规范详细设计说明书的格式与内容。
2. 适用范围
适用于软件项目的详细设计说明书的编制。
3. 文件说明
1、 本文为指南性文件，供参考使用。文件的主体内容见所附范例。在实际使用时，可以：
（1） 采用本范例规定的格式：只需删除斜体字，并替换成相应的内容即可；
（2） 或者，参考本范例，根据项目情况酌情改变格式、增加或删减部分内容。
2、 必要时，可另行编制摘要或导读作为详细设计说明书的附件，便于阅读和理解。
3、 在编制过程中，应尽可能多使用图表，以提高文件的可读性。
4、 详细设计说明书需要经过评审。
序号 修改单号 页号
条款号
修改人/日期
批准人/日期 实施日期
变更记录
注：对该文件内容增加、删除或修改均需填写此变更记录，详细记载变更信息，以保证其可追溯性。
总 13页，第 1页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
中行北京分行业务档案电子影像系统（三期）— 通用模块
详细设计说明书
（文档编号：SY-BJBOCSW-XXSJ-010-V3.0 ）
北京方正奥德计算机系统有限公司
实施部门：金融产品部
项目经理：刘海肖
生效日期：2010 年 4 月
总 13页，第 2页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
目 录
1. 编制目的..............................................................................................................................................1
2. 适用范围..............................................................................................................................................1
3. 文件说明..............................................................................................................................................1
1. 概述......................................................................................................................................................4
1.1 软件产品名称和版本.............................................................................................................. 4
1.2 模块名称、版本和编号.......................................................................................................... 4
1.3 模块的表现形式...................................................................................................................... 4
1.4 模块功能概述.......................................................................................................................... 4
1.5 模块实现方式.......................................................................................................................... 4
2. 接口设计..............................................................................................................................................4
2.1 人机界面设计.......................................................................................................................... 4
2.2 软件接口设计.......................................................................................................................... 5
2.3 外部软件接口.......................................................................................................................... 6
2.4 外部硬件接口.......................................................................................................................... 6
3. 数据库设计..........................................................................................................................................6
4. 数据设计..............................................................................................................................................9
4.1 全局静态数据.......................................................................................................................... 9
4.2 全局动态数据........................................................................................................................ 10
4.3 临时存储数据........................................................................................................................ 10
4.4 永久存储数据........................................................................................................................ 10
5. 过程设计............................................................................................................................................ 11
5.1 子功能划分............................................................................................................................ 11
5.2 算法设计................................................................................................................................ 11
5.3 流程设计................................................................................................................................ 11
5.4 过程实现................................................................................................................................ 12
6. 代码组织............................................................................................................................................12
6.1 源代码组织结构.................................................................................................................... 12
6.2 编译方式................................................................................................................................ 12
6.3 源代码文件说明.................................................................................................................... 13
总 13页，第 3页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
中行北京分行业务档案电子影像系统—通用模块
详细设计说明书
文档编号：SY-BJBOCSW-XXSJ-010-V3.0
版本：
1. 概述
1.1 软件产品名称和版本
名称：中行北京分行业务档案电子影像系统（三期）。
版本：V3.0
1.2 模块名称、版本和编号
名称：通用配置模块
版本：3.0
编号：010
1.3 模块的表现形式
模块以 JSP 程序方式实现，通过网页浏览器方式执行
1.4 模块功能概述
对系统通用化部分进行配置，具体功能如下：
1. 配置档案类型
2. 配置文档类型
3. 业务数据定义表（BUSI_TABLE_DEF_T）定义文档表信息
4. 业务数据表字段定义表（BUSI_TABLE_FIELD_DEF_T）定义文档表字段
5. 定义流水表
6. 定义流水表字段
7. 创建文档表
8. 创建流水表
1.5 模块实现方式
编程语言：JSP
框架：
开发工具及版本：
2. 接口设计
2.1 人机界面设计
对于模块中每个人机交互界面，均应详细描述以下内容：
界面类型（如普通Web 界面、普通GUI 界面、Java Applet 界面、Java Swing 界面、字符终
总 13页，第 4页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
端界面、命令行界面等）
界面图示。以图形方式给出界面外观，图形中应能清晰表现界面风格（颜色、字体、排版、
样式等），界面要素个数，界面要素位置，界面要素的名称和显示文本内容，界面的修饰
图案等。
菜单和工具栏描述。对有菜单和工具栏的界面，以文字或图形方式给出界面中的菜单和工
具栏结构，包括其中每个菜单项或工具栏项目的名称、类型、对应的处理功能等。
界面的输入数据项目。描述用户在该界面上输入的数据名称、类型、格式、相关的界面要
素名称等。
界面的输出数据项目。描述系统在该界面上输出的数据名称、类型、格式、相关的界面要
素名称等。
界面响应的用户事件。以文本或图表方式列举界面响应的每种用户事件（例如鼠标点击、
鼠标拖曳、热键等，但菜单和工具栏事件除外）的类型、名称、引发的处理动作等内容。
如该界面具有联机帮助系统，则描述联机帮助系统的实现方式（如Tooltip 帮助、界面中的
文本信息、文本文件、HTML 文件、*.doc 文件、*.hlp 帮助文件、*.chm 帮助文件等），概
述其帮助信息内容，并注明帮助信息所在的原始文件名称。
其他需要描述的界面设计内容。
2.2 软件接口设计
对模块提供的与其他模块或其他系统交互的软件接口，描述以下内容：
接口名称，版本。
接口类型。
接口表现形式（函数调用、远程交易、信号响应等）。
接口的输入项目。
接口的输出项目。
接口完成的处理功能。
总 13页，第 5页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
接口的异常处理设计。
其他需要描述的接口设计内容。
2.3 外部软件接口
对模块使用到的其他模块或其他系统的软件接口，列举以下内容：
接口所属的软件或模块名称。
接口名称。
接口的描述文档（一般为“参见《XX 模块详细设计说明书》）。无参照文档的，在此给出
接口的功能、输入、输出描述。
2.4 外部硬件接口
对模块使用到的硬件接口，在此给出该接口的规格描述（硬件名称、连接方法、电气特性等），
或注明“参见《XX》”文件说明。
3. 数据库设计
3.1 业务数据定义表（BUSI_TABLE_DEF_T）
表或视图名称
BUSI_TABLE_DEF_T
该表在系统中
业务数据定义表
的功能简述
字段数
所属表空间或
数据文件名称
EDP_TS
字段名称
字段类型
字段长度
主、外键
和精度
关系
字段
说明
字段取值范围
字段的
或约束关系
缺省值
总 13页，第 6页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
创建该表的 SQL 语句：
CREATE TABLE BUSI_TABLE_DEF_T(
TABLE_ID NUMBER(6) not null, --表 ID
TABLE_NAME VARCHAR2(40) not null, --表名
TABLE_DESC VARCHAR2(40)DEFAULT '报表', --表的描述
Table_Type
Number(1) not null ---表类型
Has_Index_Table Number(1) not null ---是否有流水表
Mapping_Table varchar(40)
---对应流水表
TABLE_FIELD_DEF CLOB,
BUSI_TYPE
CHAR(1),
RESOURCETYPE_ID NUMBER(29),
QUERY_PAGE_FILENAME VARCHAR2(100),
CONV_SOURCEFILENAME VARCHAR2(255),
CONV_INIFILENAME VARCHAR2(255),
IS_AUTO_IMP CHAR(1), --此表数据是否自动导入
IMP_CTRL_FILE_INFO CLOB, --自动导入的控制文件
IMP_CTRL_XML_INFO
CLOB, --自动导入的控制信息 XML 格式
IMP_PARAM_INFO varchar2(1000), --自动导入的参数控制
IMP_TIME_INFO varchar2(1000), --自动导入的任务时间设置
CONV_INI_FILE
CLOB, --转码信息文件
CONV_CTRL_INFO
CLOB, --转码控制文件
Primary Key("TABLE_ID"), UNIQUE("TABLE_NAME")
)tablespace "EDP_DATA_TS";
注：本表添加了 3 个字段，另外原来有些字段并未使用，暂时保留。
1.Table_Type 表类型 0：文档类型表 1：流水表 2：单个影像文档类型表 本次设计不做补录，没
有精确查询，所以暂时不用
2.Has_Index_Table 是否有流水表 0：有 1：无 标示此表是否有对应的流水表
3.Mapping_Table_Id：对应流水表 如果本表有对应的流水表，流水表 ID 号
文档类型表命名：以 documenttype_t 中 DocumentType_Id 字段和 DT 组合
DT_DocumentType_Id 如会计凭证文档表名称为 DT_1
流水表命名：JOURNAL_DocumentType_Id 在文档类型 Id 前面加上 Journal 以前已经存在的可以不
改动过来
该表中涉及到文档类型数据表及流水表配置时，表的命名应该和文档表中的表名称一致。
3.2 业务数据表字段定义表（BUSI_TABLE_FIELD_DEF_T）
表或视图名称
BUSI_TABLE_FIELD_DEF_T
字段数
总 13页，第 7页
中行北京分行业务档案电子影像项目（三期）－通用配置模块设计
该表在系统中
的功能简述
业务数据表字段定义表
所属表空间或
数据文件名称
EDP_TS
字段名称
字段类型
字段长度
主、外键
和精度
关系
字段
说明
字段取值范围
字段的
或约束关系
缺省值
创建该表的 SQL 语句：
CREATE TABLE "BUSI_TABLE_FIELD_DEF_T"(
"FIELD_ID" NUMBER(6) NOT NULL,
"TABLE_NAME" VARCHAR2(40) not null,
"Table_Id" Number(6) not null
"FIELD_NAME" VARCHAR2(40) NOT NULL,
"FIELD_DESC" VARCHAR2(40),
"DATA_TYPE" VARCHAR2(10) NOT NULL,
"DATA_LEN" NUMBER(3),
"DATA_PRECISION" NUMBER(1),
"NOT_NULL" CHAR(1) ,
"IS_PRIKEY" CHAR(1) ,
"IS_UNIQUE" CHAR(1),
"IS_SCANINDEX" CHAR(1), --是否扫描索引项
"IS_QUERYTERM" CHAR(1), --是否查询项 0 否 1 是 2 必输
"IS_VISIBLE" CHAR(1) DEFAULT '0',
PRIMARY KEY("FIELD_ID"),
FOREIGN KEY("TABLE_NAME") References "BUSI_TABLE_DEF_T"("TABLE_NAME"),
CHECK("NOT_NULL" IN ('Y', 'N')),
CHECK("IS_PRIKEY" IN ('Y', 'N')),
CHECK("IS_UNIQUE" IN ('Y', 'N')),
CHECK("IS_SCANINDEX" IN ('Y', 'N')),
CHECK("IS_QUERYTERM" IN ('0', '1','2'))
)TABLESPACE "EDP_TS";
注：此表内加上 Table_Id 做外键，标示该字段是属于哪一张表。
3.3 档案类型表（ARCHIVETYPE_T）
表或视图名称
ARCHIVETYPE _T
该表在系统中
的功能简述
档案类型表
字段数
所属表空间或
数据文件名称
EDP_TS
字段名称
字段类型
字段长度
主、外键
和精度
关系
字段
说明
字段取值范围
字段的
或约束关系
缺省值
总 13页，第 8页
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
