功能详细设计文档参考模版.docx

功能详细设计文档参考模版.docx

《功能详细设计文档参考模版.docx》由会员分享，可在线阅读，更多相关《功能详细设计文档参考模版.docx（19页珍藏版）》请在冰豆网上搜索。

功能详细设计文档参考模版

LKOA6.0表单管理

表单管理应用功能

详细设计说明书

所属项目：

LKOA6.0

项目类型

新产品开发

项目编号

文档类型：

设计文件/详细设计说明书

类型编码

文档编号：

版本号：

V1.0

最后更新人

XXX

最后更新时间

2009-XX-XX

拟制人：

拟制日期：

2009年XX月XX日

审核人：

审核日期：

2009年XX月XX日

批准人：

批准日期：

2009年XX月XX日

文件历史版本纪录

变更序号

日期

版本

变更说明

修改人

1

2009-xx-xx

1.0

新文件

2

2009-xx-xx

1.1

修改文件

1.引言

1.1.编写目的

本设计说明书描述LKOA6.0产品中某功能模块实现的详细说明，仅供开发及测试人员阅读。

1.2.设计功能概述

1.3.背景

说明：

1.LKOA6.0产品----某功能模块

2.任务提出者：

公司内部。

1.4.定义

列出本文件中用到专门术语的定义和外文首字母组词的原词组。

1.5.参考资料

1.《联达动力开发规范》

1.6.编码注意事项

本详设文档中涉及到数据逻辑描述的Sql语句仅作为数据获取逻辑准则，因未考虑其执行的性能及效率，不建议直接作为开发编码中实际的Sql语句进行使用，也不能作为衡量开发编码部分完成的标准。

请开发人员根据实际情况以及涉及的数据量灵活变通。

2.程序系统的结构

命名空间：

LinkPower.PduOA6.Mod.TableManage

程序集

LinkPower.PduOA6.Mod.TableManage

页面程序路径：

PduOA6_TableManage

Vss路径：

$/LKOA6/SourceCode/Module/Mod_TableManage/

DotNet/LinkPower.PduOA6.Mod.TableManage

3.详细设计说明

3.1.表单应用－数据表管理

3.1.1.数据表分类列表

3.1.1.1.功能描述

本功能主要用于显示和管理数据表分类。

判断操作用户的权限，具备权限的用户方可进行数据表分类的维护和管理。

3.1.1.2.输入

无

3.1.1.3.界面

3.1.1.3.1.数据表管理框架－分类<图一>

3.1.1.3.2.数据表单导航<图二>

3.1.1.3.3.数据表分类列表<图三>

3.1.1.4.页面操作说明

1界面<图一>是由<图二>和<图三>组成。

2界面<图一>是（数据表管理框架）公用页面，界面<图二>是（数据表单导航）公用页面，界面<图三>是数据分类列表页面，以下界面操作及业务规则是针对界面<图三>来描述的。

3点击“新增”按钮以及列表上的“编辑”链接，页面转向到界面<图四>。

4点击“删除”按钮以及列表上的“删除”链接时，提示“您确定要删除分类吗？

”，如果点击“删除”按钮时，列表上未选中任何一项分类，则提示“请选择要删除的分类”。

5界面上黄色背景区域为排序浮动层界面，默认不显示，点击列表上的“排序”链接时才显示，点击排序浮动层界面以外的任一区域，排序浮动层界面则隐藏，点击排序浮动层界面上的“关闭”链接，排序浮动层界面隐藏；

3.1.1.5.业务规则说明

1页面初始化时，首先进行数据表分类数据的装载：

调用（SJBFL-1）接口获取当前操作用户有权限维护的所有数据表分类信息（包括“分类序号”、“分类名称”、“分类描述”、“显示顺序”），将信息绑定到列表中进行显示。

调用接口时，‘基本过滤条件XML’参数中构建“”条件节点，节点值设置为‘0’，‘权限过滤条件XML’参数中的用户序号为当前操作用户序号（Session["UserGuid_LK"]）；

2在绑定列表数据显示时，根据每个数据表分类的‘分类序号’，调用（SJB-3）接口获取该数据分类表下的数据表数量显示到列表的‘相关数据表’一列，调用接口时，‘分类序号’参数设置为当前分类序号，‘权限过滤条件XML’参数中的用户序号设置为当前操作用户序号（Session["UserGuid_LK"]）；

3调用（SJBFL-1）接口获取“所有数据表分类信息XML”（包括“分类序号”、“分类名称”、“分类描述”、“显示顺序”），用于排序操作时浮动层数据装载的数据源。

调用接口时，‘基本过滤条件XML’参数中构建“”条件节点，节点值设置为‘0’，‘权限过滤条件XML’参数值设置为空；

4点击列表上的“排序”链接，显示排序浮动层界面，浮动层界面装载时，首先清除浮动层界面中下拉框的所有数据，然后循环“所有数据表分类信息XML”中的所有数据表分类，将其绑定到下拉框中进行显示（绑定时，下拉框的选项名称为‘分类名称’，选项值为‘显示顺序’），循环绑定的过程中，如‘分类序号’等于当前记录对应的分类序号，则该项分类信息不能绑定到下拉框，该分类的下一个分类信息绑定到下拉框时设置为选中，如果当前记录对应的分类在“所有数据表分类信息XML”中的最后一项，则下拉框默认选中最后一个分类；

5点击排序浮动层界面的“确定”链接，调用（SJBFL-4）接口调整分类的显示顺序，调用接口时，‘分类序号’参数设置为当前分类序号，‘原顺序’参数设置为当前分类显示顺序，‘新顺序’参数设置为排序浮动层界面下拉框选中的选项值，接口调用完毕后，重新装载列表数据和排序浮动层所需的数据源，即执行第1、2、3规则；

6点击列表上的“编辑”链接，将当前分类序号作为页面输入参数调用界面<图四>，页面转向到数据表分类编辑；

7点击列表上的“删除”链接，调用（SJBFL-6）接口将当前分类删除，调用接口时，‘分类序号’参数设置为当前分类序号，并根据接口的返回值判断是否删除成功，如未删除成功，给出提示“分类删除未成功，请稍候重新操作”；

8点击列表上方的“删除”按钮时，循环当前选中的分类序号，调用（SJBFL-6）接口将选中的分类删除。

调用接口时，‘分类序号’参数设置为当前循环的分类序号，并根据接口的返回值判断是否删除成功，如未删除成功，则记录未删除成功的分类序号，调用（SJBFL-2）接口获取到分类名称，拼出提示信息“以下分类删除未成功，请稍候重新操作。

”＋换行符＋未删除成功的分类名称（多个之间用逗号分隔）；

9删除操作成功后，重新装载列表数据和排序浮动层所需的数据源，即执行第1、2、3规则

3.1.1.6.输出

3.1.1.7.调用说明

3.1.1.8.程序文件

程序路径：

./PduOA6_TableManage/tbl_DataTableKind_List.aspx

类名称

tbl_DataTableKind_List

平台准备

文件路径：

$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTableKind_List.aspx

3.1.2.数据表分类编辑

3.1.2.1.功能描述

新增数据表分类，或对指定的数据表分类进行编辑。

完成操作后保存。

3.1.2.2.输入

名称

类型

说明

sKindId

String

分类序号，页面输入参数，为null或空时，表示数据表分类的新增。

3.1.2.3.界面

3.1.2.3.1.数据表分类编辑<图四>

3.1.2.4.页面操作说明

1点击“保存”按钮，需校验分类名称是否为空，如果为空，则需要提示“请输入分类名称”，并终止操作；

2点击“返回”按钮，转向到“数据表分类列表”页面（界面<图三>）；

3.1.2.5.业务规则说明

1首先初始化编辑页面数据的显示。

如果“分类序号”输入参数值不为空，则调用（SJBFL-1）接口获取当前分类的详细信息（包括“分类序号”、“分类名称”、“分类描述”、“显示顺序”），调用接口时，‘基本过滤条件XML’参数中只设置‘分类序号’节点，节点值为当前分类序号，‘权限过滤条件XML’参数设置为空；

2页面中‘显示顺序’区域数据的显示。

调用（SJBFL-1）接口获取“所有数据分类信息XML”，调用接口时，‘基本过滤条件XML’参数中构建“”条件节点，节点值设置为‘0’，‘权限过滤条件XML’参数设置为空，‘显示顺序’区域对应的选项按照以下情况进行显示：

2.1如果“分类序号”输入参数值为空，则‘显示顺序’区域的选项选中为‘显示在最后’，下拉框则绑定显示“所有数据分类信息XML”中的所有数据分类；

2.2如果“分类序号”输入参数值不为空，则调用（SJBFL-3）接口获取最大顺序号，调用接口时，参数‘协作类型’设置为‘0’，参数‘获取标识’设置为‘Z’。

如当前分类的显示顺序等于最大顺序号，则‘显示顺序’区域的选项选中为‘显示在最后’，下拉框则绑定显示“所有数据分类信息XML”中的所有数据分类；否则，‘显示顺序’区域的选项选中为‘显示在xxxx之前’，循环“所有数据分类信息XML”中的所有数据分类绑定到下拉框中进行显示，循环中，如‘分类序号’等于当前分类序号，则该分类信息不能装载到下拉框，且该分类的下一个分类信息绑定到下拉框时设置为选中；

3显示顺序区域对应的下拉框在绑定数据时，显示名称为绑定分类的‘分类名称’，对应值为绑定分类的‘显示顺序’；

4显示顺序区域选项设置为‘显示在最后’时，对应值为0，选项设置为‘显示在xxxx之前’时，对应值为下拉框当前选中的值；

5点击“保存”按钮，调用（SJBFL-5）接口保存分类信息，调用接口时，‘分类保存信息XML’参数构建‘分类序号’、‘分类名称’、‘分类描述’、‘显示顺序’、‘协作类型’等节点值，其中‘协作类型’节点值固定设置为‘0’；

3.1.2.6.输出

xxxx

String

说明：

3.1.2.7.调用说明

3.1.2.8.程序文件

程序路径：

./PduOA6_TableManage/tbl_DataTableKind_Edit.aspx

类名称

tbl_DataTableKind_Edit

平台准备

文件路径：

$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTableKind_Edit.aspx

3.1.3.数据表列表

3.1.3.1.功能描述

列出所有分类或某一分类下的数据表。

具备权限的用户可对列出的数据表进行增、删、改、查等操作。

3.1.3.2.输入

【界面<图六>】

名称

类型

说明

sKindId

String

分类序号，页面输入参数，为null或空时，表示所有分类，为-1时显示未分类的数据表

3.1.3.3.界面

3.1.3.3.1.数据表管理框架－数据表列表<图五>

3.1.3.3.2.数据表列表<图六>

3.1.3.4.页面操作说明

1界面<图五>是由<图二>和<图六>组成。

2界面<图五>是（数据表管理框架）公用页面，界面<图二>是（数据表导航）公用页面，界面<图六>是数据表列表页面，以下界面操作及业务规则是针对界面<图六>来描述的。

3点击“新增”按钮以及列表上的“编辑”链接，页面转向到界面<图八>。

4点击“删除”按钮以及列表上的“删除”链接时，弹出确认提示“您确定要删除数据表吗？

”，如果点击“删除”按钮时，列表上未选中任何一项分类，则提示“请选择要删除的数据表”。

5点击列表上的“已生成”链接时，弹出确认提示“您确定要取消生成该数据表单吗？

”；点击列表上的“未生成”链接时，弹出确认提示“您确定要生成该数据表单吗？

”

3.1.3.5.业务规则说明

1页面初始化时，首先进行数据表信息的装载：

调用（SJB-1）接口获取当前操作用户有权限维护的所有数据表信息（包括“表单序号”、“表单名称”、“表单描述”、“所属分类序号”、“显示顺序”、“系统标志”、“实际表名”、“生成标志”），将信息绑定到列表中进行显示。

调用接口时，‘权限过滤条件XML’参数中的用户序号为当前操作用户序号（Session["UserGuid_LK"]），‘需返回的结果属性项XML’参数为空，如果“分类序号”输入参数为空，则‘基本过滤条件XML’参数构建‘协作类型’节点，节点值设置为‘0’；否则，‘基本过滤条件XML’参数构建‘分类序号’节点，节点值为‘分类序号’输入参数值；

2在绑定列表数据显示时，数据表各列的数据按照以下规则显示信息：

2.1“列表选择”列（第一列）：

根据“系统标志”和“生成标志”的值，当“系统标志”为‘1’，或者“生成标志”为‘1’时，列上的复选框设置为Disable；根据“工作表单”列的值，如果大于0，则列上的复选框也设置为Disable；

2.2“数据表名称”列：

显示“表单名称”；

2.3“所属分类”列：

根据“所属分类序号”调用（SJBFL-2）接口获取“分类名称”显示；

2.4“表单类型”列：

根据“系统标志”的值，‘0’显示为‘非系统’；‘1’显示为‘系统’；

2.5“数据属性”列：

首先根据“表单序号”调用（SJB-2）接口获取到表单的“数据属性XML”，根据“数据属性XML”调用（SJBSX-1）接口获取“数据属性个数”进行显示；

2.6“生成标志”列：

根据“生成标志”的值，‘0’显示为‘未生成’（文字以红色标识），‘1’显示为‘已生成’；

2.7“工作表单”列：

根据“表单序号”调用（GZB-3）获取“相关工作表信息XML”，调用接口时，‘数据表序号’参数设置为“表单序号”，‘表单序号’参数设置为空。

解析“相关工作表信息XML”内容中的工作表节点个数作为结果进行显示；

2.8“操作”列（最后一列）：

根据“系统标志”和“生成标志”的值，当“系统标志”为‘1’，或者“生成标志”为‘1’时，列上的‘删除’链接设置为Disable；根据“工作表单”列的值，如果大于0，则列上‘删除’链接设置为Disable；

3点击列表上的“已生成”链接，将对应数据表进行取消生成操作，调用（SJB-6）接口实现，调用接口时，‘表单序号’参数设置为对应数据表的“表单序号”。

调用接口后，根据接口的返回值判断是否取消生成成功，如成功，则重新绑定列表数据的显示，如未成功，则弹出提示信息“数据表取消生成失败，错误信息如下：

”＋换行符＋接口返回信息；

4点击列表上的“未生成”链接，将对应数据表进行生成操作，调用（SJB-5）接口实现，调用接口时，‘表单序号’参数设置为对应数据表的“表单序号”，‘表单数据属性XML’设置为空。

调用接口后，根据接口的返回值判断是否生成成功，如成功，则重新绑定列表数据的显示，如未成功（接口返回值为0），则弹出提示信息“数据表生成失败，请检查数据属性设置”；

5点击列表上的“编辑”链接，将当前数据表序号作为页面输入参数调用界面<图八>，页面转向到数据表编辑；

6点击列表上的“删除”链接，调用（SJB-7）接口将当前数据表删除，调用接口时，‘表单序号’参数设置为当前数据表对应的“表单序号”，并根据接口的返回值判断是否删除成功，如未删除成功，给出提示“数据表删除未成功，请稍候重新操作”；如删除成功，重新绑定列表数据的显示；

7点击列表上方的“查询”按钮时，调用（SJB-1）接口获取当前操作用户有权限维护的所有数据表信息，同第1步操作规则，不同的是，如果输入的查询条件不为空，则调用接口时，‘基本过滤条件XML’参数需增加构建‘表单名称’节点，节点值为查询条件文本框中输入的文字；

8点击列表上方的“删除”按钮时，循环当前选中的数据表序号，调用（SJB-7）接口，调用接口时，‘表单序号’参数设置为当前循环的数据表序号，并根据接口的返回值判断是否删除成功，如未删除成功，记录未删除成功的数据表序号，调用（SJB-2）接口获取到数据表表单名称，拼出提示信息“以下数据表删除未成功，请稍候重新操作。

”＋换行符＋未删除成功的数据表名称（多个之间用逗号分隔）；无论删除是否成功，重新绑定列表数据的显示；

3.1.3.6.输出

3.1.3.7.调用说明

3.1.3.8.程序文件

程序路径：

./PduOA6_TableManage/tbl_DataTable_List.aspx

类名称

tbl_DataTable_List

平台准备

文件路径：

$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTable_List.aspx

3.1.4.数据表编辑

3.1.4.1.功能描述

新增数据表，及对数据表的数据属性进行编辑。

对指定的数据表及其数据属性进行编辑。

3.1.4.2.输入

【界面<图八>】

名称

类型

说明

sDataTableId

String

数据表序号，页面输入参数，为null或空时，表示数据表的新增

3.1.4.3.界面

3.1.4.3.1.数据表管理框架－数据表编辑<图七>

3.1.4.3.2.数据表编辑<图八>

3.1.4.4.页面操作说明

1界面<图七>是由<图二>和<图八>组成。

2界面<图七>是（数据表管理框架）公用页面，界面<图二>是（数据表导航）公用页面，界面<图八>是数据表编辑页面，以下界面操作及业务规则是针对界面<图八>来描述的。

3点击“保存”按钮，需校验数据表名称输入是否为空，如果为空，则需要提示“请输入数据表名称”，并终止操作；

4点击“保存”按钮保存成功后，转向到“数据表列表”页面（界面<图六>）；

5点击“返回”按钮，弹出确认提示“您确定要不保存返回吗？

”，确定后转向到“数据表列表”页面（界面<图六>）；

3.1.4.5.业务规则说明

1首先初始化编辑页面数据的显示。

如果“数据表序号”输入参数值不为空，则调用（SJB-1）接口获取当前数据表的详细信息（包括“表单序号”、“表单名称”、“表单描述”、“所属分类序号”、“系统标志”、“实际表名”、“数据属性XML”），调用接口时，‘基本过滤条件XML’参数中只构建‘表单序号’节点，节点值为“数据表序号”输入参数值，‘权限过滤条件XML’参数设置为空。

‘需返回的结果属性项XML’参数构建“表单序号”、“表单名称”、“表单描述”、“所属分类序号”、“系统标志”、“实际表名”、“数据属性XML”等标识；

2页面中‘所属分类’区域的下拉框数据调用（SJBFL-1）接口获取“所有数据分类信息XML”（包括“分类序号”、“分类名称”）进行绑定显示，在绑定数据时，下拉框的显示名称为“分类名称”，对应值为绑定分类的“分类序号”，另外，下拉框的第一项的名称固定设置为文字‘无分类’，对应选项值设置为空。

在调用接口时，‘基本过滤条件XML’参数中构建“”条件节点，节点值设置为‘0’，‘权限过滤条件XML’参数设置为空，‘所属分类’下拉框的选项值按照以下情况进行显示：

2.1如果“数据表序号”输入参数值为空，则‘所属分类’下拉框的选项值固定选中为第一项，即‘无分类’选项；

2.2如果“数据表序号”输入参数值不为空，则将‘所属分类’下拉框中选项值等于该数据表的“所属分类序号”的选项设置为选中；

3页面中红色标识区域为数据表数据属性编辑区，该区域数据由（数据属性编辑）控件来装载，控件的初始化根据以下情况来进行：

3.1如果“数据表序号”输入参数值为空，则控件的‘数据属性XML’参数设置为空，‘只读标志’设置为false，‘已生成标志’设置为false；

3.2如果“数据表序号”输入参数值为空，则控件的‘数据属性XML’参数设置为“数据属性XML”，‘只读标志’参数设置为false，根据“实际表名”的值，如果非空，则‘已生成标志’参数设置为true，如果为空，则‘已生成标志’参数设置为false；

4点击“保存”按钮，调用（SJB-4）接口保存分类信息，调用接口时，‘数据表保存信息XML’参数按照如下规则构建各节点及各节点的值：

4.1‘表单序号’节点：

“数据表序号”输入参数值；

4.2‘表单名称’节点：

界面上“数据表名称”的输入值；

4.3‘表单描述’节点：

界面上“数据表说明”的输入值；

4.4‘所属分类序号’节点：

界面上“所属分类”选中的选项值；

4.5‘系统标志’节点：

固定设置为‘0’；

4.6‘实际表名’节点：

之前获取的“实际表名”值；

4.7‘数据属性XML’：

通过（数据属性编辑）控件的属性获取；

4.8‘协作类型’节点：

固定设置为‘0’；

3.1.4.6.输出

3.1.4.7.调用说明

3.1.4.8.程序文件

程序路径：

./PduOA6_TableManage/tbl_DataTable_Edit.aspx

类名称

tbl_DataTable_Edit

平台准备

文件路径：

$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTable_Edit.aspx

3.2.公用页面

3.2.1.数据表管理框架

3.2.1.1.功能描述

数据表管理框架公用页面主要用来载入数据表单导航公用页面以及在数据表单导航页面中指向的各功能页面。

任何与数据表管理相关的功能操作都在此框架页面中进行。

3.2.1.2.输入

无

3.2.1.3.界面

3.2.1.3.1.数据表单管理框架

3.2.1.4.页面操作说明

1页面分为左中右两个区域，左区载入数据表单导航公用页面，中间区域为框架控制功能条，右区载入导航页面所指向的功能页面，右区默认载入的为（3.1.3数据表列表）功能页面。

2点击中间区域为框架控制功能条，将左区框架隐藏，再次点击，将左区框架显示。

3左区框架宽度为120像素。

中间框架宽度为5像素。

4左区中的链接目标框架为右区框架。

3.2.1.5.业务规则说明

3.2.1.6.输出

3.2.1.7.调用说明

3.2.1.8.程序文件

【主框架页面】

程序路径：

./PduOA6_TableManage/tbl_DataTableMgr_Frame.aspx

类名称

tbl_DataTableMgr_Frame

平台准备

文件路径：

$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTableMgr_Frame.aspx

【中间框架页面】

程序路径：

./PduOA6_TableManage/tbl_DataTableMgr_Middle.aspx

类名称

tbl_DataTableMgr_Middle

平台准备

文件路径：

$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTableMgr_Middle.aspx

3.2.2.数据表单导航

3.2.2.1.功能描述

该页面列出所有数据表单分类以及固定的‘未分类’节点，在每个表单分类下列出当前操作用户有权限进行维护的数据表单。

通过该导航页面，根