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

LKOA6.0表单管理表单管理应用功能详细设计说明书所属项目：LKOA6.0项目类型新产品开发项目编号文档类型：设计文件/详细设计说明书类型编码文档编号：版本号：V1.0最后更新人XXX最后更新时间2009-XX-XX拟制人：拟制日期：2009年XX月XX日审核人：审核日期：2009年XX月XX日批准人：批准日期：2009年XX月XX日文件历史版本纪录变更序号日期版本变更说明修改人12009-xx-xx1.0新文件22009-xx-xx1.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_TableManageVss路径：$/LKOA6/SourceCode/Module/Mod_TableManage/DotNet/LinkPower.PduOA6.Mod.TableManage3.详细设计说明3.1.表单应用－数据表管理3.1.1.数据表分类列表3.1.1.1.功能描述本功能主要用于显示和管理数据表分类。判断操作用户的权限，具备权限的用户方可进行数据表分类的维护和管理。3.1.1.2.输入无3.1.1.3.界面3.1.1.3.1.数据表管理框架－分类图一数据表单管理数据表单管理数据表单分类列表行文格式国标类行政管理类分类名称91相关数据表排序编辑删除排序编辑删除操作删除数据表单导航刷新数据表单导航类型A〔1〕分类B〔8〕分类…〔0〕分类管理未分类〔12〕（财务、审计、税务等适用）行政管理适用分类描述新增显示在之前确定关闭显示其他分类------3.1.1.3.2.数据表单导航图二数据表单导航刷新数据表单导航类型A〔1〕分类B〔8〕分类…〔0〕分类管理未分类〔12〕3.1.1.3.3.数据表分类列表图三数据表单分类列表行文格式国标类行政管理类分类名称91相关数据表排序编辑删除排序编辑删除操作删除（财务、审计、税务等适用）行政管理适用分类描述新增显示在之前确定关闭显示其他分类3.1.1.4.页面操作说明1界面图一是由图二和图三组成。2界面图一是（数据表管理框架）公用页面，界面图二是（数据表单导航）公用页面，界面图三是数据分类列表页面，以下界面操作及业务规则是针对界面图三来描述的。3点击“新增”按钮以及列表上的“编辑”链接，页面转向到界面图四。4点击“删除”按钮以及列表上的“删除”链接时，提示“您确定要删除分类吗？”，如果点击“删除”按钮时，列表上未选中任何一项分类，则提示“请选择要删除的分类”。5界面上黄色背景区域为排序浮动层界面，默认不显示，点击列表上的“排序”链接时才显示，点击排序浮动层界面以外的任一区域，排序浮动层界面则隐藏，点击排序浮动层界面上的“关闭”链接，排序浮动层界面隐藏；3.1.1.5.业务规则说明1页面初始化时，首先进行数据表分类数据的装载：调用（SJBFL-1）接口获取当前操作用户有权限维护的所有数据表分类信息（包括“分类序号”、“分类名称”、“分类描述”、“显示顺序”），将信息绑定到列表中进行显示。调用接口时，‘基本过滤条件XML’参数中构建“IncludeCondXmlKindFlag”条件节点，节点值设置为‘0’，‘权限过滤条件XML’参数中的用户序号为当前操作用户序号（Session[UserGuid_LK]）；2在绑定列表数据显示时，根据每个数据表分类的‘分类序号’，调用（SJB-3）接口获取该数据分类表下的数据表数量显示到列表的‘相关数据表’一列，调用接口时，‘分类序号’参数设置为当前分类序号，‘权限过滤条件XML’参数中的用户序号设置为当前操作用户序号（Session[UserGuid_LK]）；3调用（SJBFL-1）接口获取“所有数据表分类信息XML”（包括“分类序号”、“分类名称”、“分类描述”、“显示顺序”），用于排序操作时浮动层数据装载的数据源。调用接口时，‘基本过滤条件XML’参数中构建“IncludeCondXmlKindFlag”条件节点，节点值设置为‘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.aspx3.1.2.数据表分类编辑3.1.2.1.功能描述新增数据表分类，或对指定的数据表分类进行编辑。完成操作后保存。3.1.2.2.输入名称类型说明sKindIdString分类序号，页面输入参数，为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’参数中构建“IncludeCondXmlKindFlag”条件节点，节点值设置为‘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.输出xxxxString说明：3.1.2.7.调用说明3.1.2.8.程序文件程序路径：./PduOA6_TableManage/tbl_DataTableKind_Edit.aspx类名称tbl_DataTableKind_Edit平台准备文件路径：$/LKOA6/平台准备文件/PduOA6_TableManage/tbl_DataTableKind_Edit.aspx3.1.3.数据表列表3.1.3.1.功能描述列出所有分类或某一分类下的数据表。具备权限的用户可对列出的数据表进行增、删、改、查等操作。3.1.3.2.输入【界面图六】名称类型说明sKindIdString分类序号，页面输入参数，为null或空时，表示所有分类，为-1时显示未分类的数据表3.1.3.3.界面3.1.3.3.1.数据表管理框架－数据表列表图五数据表单管理数据表单管理数据表单列表数据表B数据表A数据表名称21工作表单编辑删除编辑删除操作删除无分类B分类A所属分类未生成已生成生成标志510数据属性输入表单名称查询点击生成非系统系统表单类型新增共有xxx条记录第0/0页首页上一页下一页尾页跳转到页GO点击取消生成数据表单导航刷新数据表单导航类型A〔1〕分类B〔8〕分类…〔0〕分类管理未分类〔12〕------3.1.3.3.2.数据表列表图六数据表单列表数据表B数据表A数据表名称21工作表单编辑删除编辑删除操作删除无分类B分类A所属分类未生成已生成生成标志510数据属性输入表单名称查询点击生成非系统系统表单类型新增共有xxx条记录第0/0页首页上一页下一页尾页跳转到页GO点击取消生成3.1.3.4.页面操作说明1界面图五是由图二和图六组成。2界面图五是（数据表管理框架）公用页面，界面图二是（数据表导航）公用页面，界面图六