【XXXX项目】二次开发设计说明书

文档编号：
XXXX
二次开发设计说明书
XXXXXX有限公司
目录
1.引言 (3)
1.1.编写目的 (3)
1.2.项目背景 (3)
1.3.参考资料 (3)
2.二次开发结构 (3)
2.1.软件结构 (3)
2.2.条件与限制 (4)
2.3.二次开发设计框架 (4)
3.二次开发内容 (4)
3.1.内容1（如：窗体定制—- ITEM属性表单的定制） (4)
3.2.内容2 (5)
3.3.内容n (5)
4.接口设计 (5)
4.1内部接口 (5)
4.2外部接口 (6)
5.数据结构设计 (6)
5.1.库结构 (6)
5.2.表结构 (6)
6.出错处理设计 (6)
6.1.出错信息 (6)
6.2.补救措施 (6)
6.3.系统维护设计 (6)
7.其他 (6)
1.引言
1.1. 编写目的
本文档主要针对系统的二次开发部分。

对在《实施总体设计方案》中描述的需要二次开发的内容，详细进行描述。

为编程人员、测试人员、实施人员和维护人员之间提供共同的参考依据，对XX软件功能及集成模块的实现作详细描述。

本说明书面向对象为编程人员、测试人员、实施人员和维护人员。

1.2. 项目背景
本项目软件开发平台：
本项目软件二次开发实施单位：
1.3. 定义
PLM (product life cycle management)：产品生命周期管理
PDM (product data management)：产品数据管理
BOM (bill of material)：材料明细表
CAPP(Computer Adied Process Planning)：计算机辅助工艺设计
PSE (product structure editor)：产品结构编辑器
ItemRevision：版本零部件
……
1.4. 参考资料
《XXXX项目需求规格说明书》
《XXXX项目总体设计方案》
……
2.二次开发结构
2.1. 软件结构
例如：
TCEng软件的层次构成
–Portal Java clients. 客户端
–TCEng server 服务器端
–Oracle 后台数据库
–TCEngFS 文档服务器
TCEng 存储数据的方式：
结构化数据——存储于Oracle数据库中
文件——存储于卷Volume中
2.2. 条件与限制
2.3. 二次开发设计框架
客户程序类的层次如图所示：
图：
3.二次开发内容
对于需要开发的内容有两类：
一类是需要重新进行开发的内容，这相当于重新开发某一模块的功能。

如：PDM系统我们是通过便量配置实现但是这一次需要采用加减BOM的方法实现。

需要重新分析和设计，做出类似于详细设计那种程度的设计；
另一类是仅需要简单定制即可完成的内容。

如加几个属性、绘制卡片等。

这一类仅仅需要简单的文字描述即可。

3.1. 内容1（如：窗体定制—- ITEM属性表单的定制）
首先描述需求分析。

如：
1）在PLM的Schema Editor中创建ITEM表单属性表
2）在PLM的LOV中创建ITEM表单属性的可选项对应的值列表
3）使用JAVA进行二次开发，制作新的MasterForm。

4）在form_user.properties中添加Item\ Master.FORMDEFINITION项，绑定MasterForm 到定制的表单。

5）开发使用语言：JAVA
6）主要类描述:
public class ItemRevisionMasterForm extends AbstractIMANForm {
//重载checkForm()，绑定数据库表单
public void checkForm() throws Exception {}
//初始化页面中与LOV关联的列表框
private void initializeComField() throws IMANException {}
//读入ITEM的表单属性
public void loadForm() throws IMANException {}
//保存ITME的表单属性
public void saveForm() {}
}
3.2. 内容2
……
3.3. 内容n
……
4.接口设计
4.1. 内部接口
软件模块分配
例如：
入库软件模块；
入库软件模块是整个软件的基础，为整个软件提供分析数据，其接口要求如下表：
[此处加入接口要求表]
分析软件模块；
分析软件模块包括电能，电压，电量，谐波4个模块，是整个软件的功能实现，实现软件的分析功能，其接口要求分别如表1，表2，表3，表4及表5：
[此处加入表]
说明：表5 是xxxxxx.
报表软件模块；
报表软件模块是为整用户提供报表功能，其接口要求如下表：
[此处加入接口要求表]
主界面软件模块；
主界面软件模块是整个软件的总控，为软件的各个模块提供接口，其接口要求如下表：[此处加入接口要求表]
由于上表较长，表中分为3部分，表中第2部分说明为：xxxxxxxxxxxxx
模块之间的关系
[此处加入模块之间的关系]
4.2. 外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持系统之间的接口关系。

5.数据结构设计
5.1. 库结构
[此处加入库结构]
5.2. 表结构
[此处加入全局定义]
存到哪里等
6.出错处理设计
6.1. 出错信息
用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含
意及处理方法。

6.2. 补救措施
说明故障出现后可能采取的变通措施。

包括：
后备技术：说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建
立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一
种后备技术。

降效技术：说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所
需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记
录。

恢复及再启动技术：说明将使用的恢复再启动技术，使软件从故障点恢复执行或使
软件从头开始重新运行的方法。

6.3. 系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排
用于系统的检查与维护的检测点和专用模块。

7.其他
[相关参考资料及文档、附件文档（如数据的E-R图等）、其他信息]。