基础数据功能设计文档模板.docx
《基础数据功能设计文档模板.docx》由会员分享，可在线阅读，更多相关《基础数据功能设计文档模板.docx（30页珍藏版）》请在冰豆网上搜索。
基础数据功能设计文档模板
基础数据功能设计文档
文件状态：
[√]草稿
[]正式发布
[]正在修改
文件标识：
当前版本：
作者：
完成日期：
版本历史
版本
作者
批准
生效日期
备注
一编写目的
主要在本文档中说明了XX项目基础数据模块相应功能的需求设计、开发框架和开发流程及技术点，此模块主要包括部门管理、物料管理、供应商\客户管理、岗位管理、人员管理、单位管理、设备管理、库房管理等。
这些模块主要是基础数据的基本维护，没有复杂的逻辑功能，大多数是增删改查的基本操作。
其中有几个模块的数据是通过接口从现有Erp、Hr系统中获得，例如：
部门、人员、物料等，在文档中也会做详细说明。
二功能模块
1基本结构图
2各功能数据结构设计及软件开发逻辑
功能结构概述：
2.1部门管理
（1）功能相关表
a部门信息表-BasDept
字段名称
字段代码
字段类型
字段长度
是否为空
是否是主键
规则
编号
ObjID
int
FALSE
TRUE
自动增长
部门代码
DepCode
varchar（10）
10
FALSE
五位流水
部门名称
DepName
varchar（100）
100
FALSE
部门级别
DepLevel
int
FALSE
上级部门编号
ParentNum
varchar（10）
10
备注
Remark
varchar（100）
100
ERP代码
ERPCode
varchar（100）
100
HR代码
HRCode
varchar（100）
100
显示序号
DisplayId
int
删除标志
DeleteFlag
char
（1）
1
默认值为0
（2）项目相关文件
展现层文件位置：
项目\Web\Manager\BasicInfo\DepartmentInfo\Department.aspx
项目\Web\Manager\BasicInfo\DepartmentInfo\Department.aspx.cs
实体类文件位置：
项目\Mesnac.Entity\BasDept.cs
数据访问层文件位置：
项目\Mesnac.Data\Interface\IBasDeptService.cs
项目\Mesnac.Data\Implements\BasDeptService.cs
业务逻辑层文件位置：
项目\Mesnac.Business\Interface\IBasDeptManager.cs
项目\Mesnac.Business\Implements\BasDeptManager.cs
（3）部门管理功能点剖析
a添加部门信息功能
实例名称
添加部门
使用者
部门维护人员
说明
操作者通过此操作进行部门的添加。
先决条件
操作者拥有添加部门的权限。
需要点击左侧的部门树形结构节点。
运行结果
创建新的部门
一般流程
用户操作
1.点击左侧部门列表，选择需要添加部门的上级部门。
3.点击添加按钮。
5.填写部门名称、选择ERP编码、HR编码、显示序号、备注等。
7.点击确定进行部门添加。
系统响应
2.根据点击部门刷新列表，展示其子部门。
并记录点击部门编号。
4.弹出部门添加框，父级部门已填写为左侧树点击部门。
6.校验填入项是否符合校验规则。
8.部门添加框关闭，保存部门信息并刷新部门列表。
可选流程
1.点击取消按钮，部门添加框关闭，不保存添加的部门信息。
例外情况
1.点击保存，校验不通过，提示校验不通过提示。
特定需求
1.部门名称禁止重复。
2.部门名称禁止为空。
备注
无
b修改部门信息功能
实例名称
修改部门
使用者
部门维护人员
说明
操作者通过此操作进行部门信息的修改。
先决条件
操作者拥有修改部门的权限
运行结果
修改部门信息。
一般流程
用户操作
1.点击需要修改部门的操作中修改按钮
3.对部门的信息进行修改。
5.点击确定进行部门修改。
系统响应
2.弹出部门修改框，加载修改部门的数据，填充到修改框中。
4.校验填入项是否符合校验规则。
6.部门修改框关闭，保存部门信息并刷新部门列表。
可选流程
1.点击取消按钮，部门修改框关闭，不保存部门列表。
例外情况
1.点击保存，校验不通过，提示校验不通过提示。
特定需求
1.部门名称禁止重复。
2.部门名称禁止为空。
备注
无
c删除部门信息功能
实例名称
删除部门
使用者
部门维护人员
说明
操作者通过此操作进行部门信息的删除
先决条件
操作者拥有删除部门的权限
运行结果
删除部门信息。
一般流程
用户操作
1.点击需要删除部门的操作中删除按钮
3.点击确认按钮。
系统响应
2.弹出删除确认提示框。
提示您确定需要删除此条信息?
4.通过部门信息的编号，在后台对DeleteFlag赋值1。
并对列表进行刷新操作。
可选流程
1.点击取消按钮，删除提示框关闭，不做删除处理。
例外情况
1.如果部门有子部门则不许删除。
2.如果部门为顶级部门则不许删除。
3.已在人员管理功能中被使用的部门禁止删除。
特定需求
备注
无
d查询部门信息功能
实例名称
查询部门
使用者
部门维护人员
说明
操作者通过此操作进行部门信息的筛选查询
先决条件
操作着拥有查询部门的权限
运行结果
根据填写条件筛选出部门并刷新列表
一般流程
用户操作
1.填写查询条件：
部门编号、部门名称、ERP编号、备注。
3.点击查询按钮。
系统响应
2.校验查询条件是否符合校验规则。
4.根据查询条件对部门信息进行筛选并刷新列表展示。
可选流程
例外情况
1.如果部门编号不符合校验规则，则红线提示，点击查询按钮会清空不符合规则的部门编号。
特定需求
1.部门编号只允许为数字
2.部门名称、ERP编码、备注可为模糊查询。
3.查询筛选的部门为所有部门的筛选集合，并不是左侧点击的节点的子级部门筛选。
备注
无
e历史查询部门功能
实例名称
历史查询部门
使用者
部门维护人员
说明
操作者通过此操作进行部门信息的历史筛选查询
先决条件
操作着拥有历史查询部门的权限
运行结果
根据填写条件筛选出部门并刷新列表，包含已删除的部门
一般流程
用户操作
1.填写查询条件：
部门编号、部门名称、ERP编号、备注。
3.点击历史查询按钮。
系统响应
2.校验查询条件是否符合校验规则。
4.根据查询条件对部门信息进行筛选并刷新列表。
5.查询的集合中包括已删除和未删除的所有部门，已删除部门会以红色底色展示，并以恢复按钮代替修改和删除按钮。
可选流程
例外情况
1.如果部门编号不符合校验规则，则红线提示，点击查询按钮会清空不符合规则的部门编号。
特定需求
1.部门编号只允许为数字
2.部门名称、ERP编码、备注可为模糊查询。
3.历史查询筛选的部门为所有部门的筛选集合，并不是左侧点击的节点的子级部门筛选。
备注
无
f导出部门信息功能
实例名称
导出部门信息
使用者
部门维护人员
说明
操作者通过此操作进行部门信息导出Excel文件
先决条件
1.操作着拥有导出部门的权限。
2.已根据查询或历史查询功能获得需要导出的部门列表。
运行结果
导出查询部门列表的Excel文件
一般流程
用户操作
1.点击导出按钮。
系统响应
2.根据列表的内容进行Excel生成，并弹出提示是否保存部门信息.xls。
可选流程
例外情况
1.如果导出前对查询条件做了更改，则导出的部门信息集合会根据当前查询条件做筛选。
特定需求
备注
无
g恢复部门信息功能
实例名称
恢复部门信息
使用者
部门维护人员
说明
操作者通过此操作进行部门信息的恢复
先决条件
1.操作着拥有恢复部门的权限。
2.已经进行了历史查询操作，将要恢复的数据已被删除。
运行结果
恢复已被删除的部门信息。
一般流程
用户操作
1.点击恢复按钮。
3.点击是。
系统响应
2.弹出提示框，提示您确定需要恢复此条信息?
4.关闭提示框，将部门信息进行恢复，DeleteFlag赋值为0。
并刷新部门列表。
可选流程
1.点击否则关闭提示框，不做恢复操作，部门列表不会刷新。
例外情况
1.如果恢复的部门有上级部门未恢复，则会提示恢复失败：
请先恢复父级部门[父级部门名称]。
特定需求
备注
无
（4）权限定义
对查询、历史查询、导出、修改、删除、恢复、添加等按钮进行了权限的限定。
用户初次点击部门管理时会显示“无权限使用此功能，请确认权限!
”，此时需要进入对应系统管理模块为此用户分配权限。
（5）接口规范
a接口形式
部门信息目前玲珑轮胎存在人力资源管理系统，所以玲珑人力资源系统维护人员的基本信息，需要玲珑开发人力资源系统定期（每1小时）或手工即时操作将数据同步到MES系统的中间数据表，并将更新的数据记录进行标记。
MES系统定期（每1分钟读取中间数据表的数据。
下发到现场及管理系统使用。
b接口定义
HR.HR_ORG
MES.BasDept
字段名
字段类型
字段名
字段类型
基本规则
ObjID
int
自动增长
DepCode
varchar（10）
流水五位方法
Name
varchar（200）
DepName
varchar（100）
复制数据
DepLevel
int
根据逐级筛选进行定义
Parent_ID
varchar（200）
ParentNum
varchar（10）
逐级筛选
ORG_ID
varchar（200）
HRCode
varchar（100）
复制数据
STATE
varchar（200）
DisplayId
int
DeleteFlag
char
（1）
默认为0
2.2供应商/客户管理
（1）功能相关表
a厂商类别表
字段名称
字段代码
字段类型
字段长度
是否为空
是否是主键
规则
厂家类别编码
ObjID
int
TRUE
厂家类别名称
FactoryTypeName
varchar（50）
50
FALSE
备注
Remark
varchar（100）
100
FALSE
删除标志
DeleteFlag
char
（1）
1
FALSE
b厂商信息表
字段名称
字段代码
字段类型
字段长度
是否为空
是否是主键
规则
厂家编码
ObjID
int
TRUE
厂家类别
FacType
int
FALSE
厂家名称
FacName
varchar（100）
100
FALSE
厂家简称
FacSimpleName
varchar（50）
50
FALSE
厂家地址
FacAddress
varchar（100）
100
FALSE
厂家邮编
FacPostCode
char（6）
6
FALSE
法人代表
Corporation
varchar（50）
50
FALSE
联系电话
ContactTel
varchar（50）
50
FALSE
联系人
ContactMan
varchar（50）
50
FALSE
负责人
DutyMan
varchar（50）
50
FALSE
电子邮件
Email
varchar（50）
50
FALSE
HR编码
HRCode
varchar（10）
10
FALSE
ERP编码
ERPCode
varchar（10）
10
FALSE
备注
Remark
varchar（100）
100
FALSE
删除标志
DeleteFlag
char
（1）
1
FALSE
（2）项目相关文件
展现层文件位置：
厂商信息
项目\Web\Manager\BasicInfo\SupplierCustomerInfo\FactoryInfo.aspx
项目\Web\Manager\BasicInfo\SupplierCustomerInfo\FactoryInfo.aspx.cs
厂商类别
项目\Web\Manager\BasicInfo\SupplierCustomerInfo\FactoryType.aspx
项目\Web\Manager\BasicInfo\SupplierCustomerInfo\FactoryType.aspx.cs
实体类文件位置：
厂商信息
项目\Mesnac.Entity\BasFactoryInfo.cs
厂商类别
项目\Mesnac.Entity\BasFactoryType.cs
数据访问层文件位置：
厂商信息
项目\Mesnac.Data\Interface\IBasFactoryInfoService.cs
项目\Mesnac.Data\Implements\BasFactoryInfoService.cs
厂商类别
项目\Mesnac.Data\Interface\IBasFactoryTypeService.cs
项目\Mesnac.Data\Implements\BasFactoryTypeService.cs
业务逻辑层文件位置：
厂商信息
项目\Mesnac.Business\Interface\IBasFactoryInfoManager.cs
项目\Mesnac.Business\Implements\BasFactoryInfoManager.cs
厂商类别
项目\Mesnac.Business\Interface\IBasFactoryTypeManager.cs
项目\Mesnac.Business\Implements\BasFactoryTypeManager.cs
（3）厂商类别功能点剖析
a添加厂商类别功能
实例名称
添加厂商类别信息
使用者
厂商类别维护人员
说明
操作者通过此操作进行厂商类别信息的添加
先决条件
1.操作着拥有添加厂商类别信息的权限。
运行结果
添加了新的厂商类别。
一般流程
用户操作
1.点击添加按钮。
3.填写厂商类别名称，备注。
5.点击确认按钮。
系统响应
2.弹出厂商类别添加框。
4.校验填入项是否符合校验规则。
6.厂商类别添加框关闭，保存厂商类别信息并刷新厂商类别列表。
可选流程
1.点击取消关闭厂商类别添加框，不保存添加的厂商类别信息。
例外情况
1.点击保存，校验不通过，提示校验不通过提示。
特定需求
1.厂商类别名称禁止为空。
2.厂商类别名称禁止重复。
备注
无
b修改厂商类别功能
实例名称
修改厂商类别信息
使用者
厂商类别维护人员
说明
操作者通过此操作进行厂商类别信息的修改。
先决条件
操作者拥有修改厂商类别的权限
运行结果
修改厂商类别信息。
一般流程
用户操作
1.点击需要修改厂商类别的操作菜单中修改按钮
3.对厂商类别的信息进行修改。
5.点击确定进行厂商类别修改。
系统响应
2.弹出厂商类别修改框，加载修改厂商类别的数据，填充到修改框中。
4.校验填入项是否符合校验规则。
6.厂商类别修改框关闭，保存厂商类别信息并刷新厂商类别列表。
可选流程
1.点击取消按钮，厂商类别修改框关闭，不保存厂商类别列表。
例外情况
1.点击保存，校验不通过，提示校验不通过提示。
特定需求
1.厂商类别名称禁止重复。
2.厂商类别名称禁止为空。
备注
无
c删除厂商类别功能
实例名称
删除厂商类别
使用者
厂商类别维护人员
说明
操作者通过此操作进行厂商类别信息的删除
先决条件
操作者拥有删除厂商类别的权限
运行结果
删除厂商类别信息。
一般流程
用户操作
1.点击需要删除厂商类别的操作中删除按钮
3.点击确认按钮。
系统响应
2.弹出删除确认提示框。
提示您确定需要删除此条信息?
4.通过厂商类别信息的编号，在后台对DeleteFlag赋值1。
并对列表进行刷新操作。
可选流程
1.点击取消按钮，删除提示框关闭，不做删除处理。
例外情况
1.已在厂商信息管理功能中被使用的厂商类别禁止删除。
特定需求
备注
无
d查询厂商类别功能
实例名称
查询厂商类别
使用者
查询厂商类别维护人员
说明
操作者通过此操作进行查询厂商类别信息的筛选查询
先决条件
操作着拥有查询查询厂商类别的权限
运行结果
根据填写条件筛选出查询厂商类别并刷新列表
一般流程
用户操作
1.填写查询条件：
厂商类别编号、厂商类别名称、备注。
3.点击查询按钮。
系统响应
2.校验查询条件是否符合校验规则。
4.根据查询条件对查询厂商类别信息进行筛选并刷新列表展示。
可选流程
例外情况
1.如果厂商类别编号不符合校验规则，则红线提示，点击查询按钮会清空不符合规则的厂商类别编号。
特定需求
1.厂商类别编号只允许为数字
2.厂商类别名称备注可为模糊查询。
备注
无
e历史查询厂商类别功能
实例名称
历史查询厂商类别
使用者
厂商类别维护人员
说明
操作者通过此操作进行厂商类别信息的历史筛选查询
先决条件
操作着拥有历史查询厂商类别的权限
运行结果
根据填写条件筛选出厂商类别并刷新列表，包含已删除的厂商类别
一般流程
用户操作
1.填写查询条件：
厂商类别编号、厂商类别名称、备注。
3.点击历史查询按钮。
系统响应
2.校验查询条件是否符合校验规则。
4.根据查询条件对厂商类别信息进行筛选并刷新列表。
5.查询的集合中包括已删除和未删除的所有厂商类别，已删除厂商类别会以红色底色展示，并以恢复按钮代替修改和删除按钮。
可选流程
例外情况
1.如果厂商类别编号不符合校验规则，则红线提示，点击查询按钮会清空不符合规则的厂商类别编号。
特定需求
1.厂商类别编号只允许为数字
2.厂商类别名称、备注可为模糊查询。
备注
无
f恢复厂商类别功能
实例名称
恢复厂商类别信息
使用者
厂商类别维护人员
说明
操作者通过此操作进行厂商类别信息的恢复
先决条件
1.操作着拥有恢复厂商类别的权限。
2.已经进行了历史查询操作，将要恢复的数据已被删除。
运行结果
恢复已被删除的厂商类别信息。
一般流程
用户操作
1.点击恢复按钮。
3.点击是。
系统响应
2.弹出提示框，提示您确定需要恢复此条信息?
4.关闭提示框，将厂商类别信息进行恢复，DeleteFlag赋值为0。
并刷新厂商类别列表。
可选流程
1.点击否则关闭提示框，不做恢复操作，厂商类别列表不会刷新。
例外情况
特定需求
备注
无
（4）厂商信息功能点剖析
a添加厂商信息功能
实例名称
添加厂商信息
使用者
厂商信息维护人员
说明
操作者通过此操作进行厂商信息的添加
先决条件
1.操作着拥有添加厂商信息的权限。
运行结果
添加了新的厂商信息。
一般流程
用户操作
1.点击添加按钮。
3.填写厂商信息的属性。
5.点击确认按钮。
系统响应
2.弹出厂商信息添加框。
4.校验填入项是否符合校验规则。
6.厂商信息添加框关闭，保存厂商信息并刷新厂商信息列表。
可选流程
1.点击取消关闭厂商信息添加框，不保存添加的厂商信息。
例外情况
1.点击保存，校验不通过，提示校验不通过提示。
特定需求
1.厂商名称禁止为空。
2.厂商名称禁止重复。
备注
无
b修改厂商信息功能
实例名称
修改厂商信息
使用者
厂商信息维护人员
说明
操作者通过此操作进行厂商信息的修改。
先决条件
操作者拥有修改厂商信息的权限
运行结果
修改厂商信息。
一般流程
用户操作
1.点击需要修改厂商信息的操作菜单中修改按钮
3.对厂商信息进行修改。
5.点击确定进行厂商信息修改。
系统响应
2.弹出厂商信息修改框，加载修改厂商信息的数据，填充到修改框中。
4.校验填入项是否符合校验规则。
6.厂商信息修改框关闭，保存厂商信息并刷新厂商信息列表。
可选流程
1.点击取消按钮，厂商信息修改框关闭，不保存厂商信息列表。
例外情况
1.点击保存，校验不通过，提示校验不通过提示。
特定需求
1.厂商名称禁止重复。
2.厂商名称禁止为空。
备注
无
c删除厂商信息功能
实例名称
删除厂商信息
使用者
厂商信息维护人员
说明
操作者通过此操作进行厂商信息的删除
先决条件
操作者拥有删除厂商信息的权限
运行结果
删除厂商信息。
一般流程
用户操作
1.点击需要删除厂商信息的操作中删除按钮
3.点击确认按钮。
系统响应
2.弹出删除确认提示框。
提示您确定需要删除此条信息?
4.通过厂商信息的编号，在后台对DeleteFlag赋值1。
并对列表进行刷新操作。
可选流程
1.点击取消按钮，删除提示框关闭，不做删除处理。
例外情况
1.已被使用的厂商信息禁止删除。
特定需求
备注
无
d查询厂商信息功能
实例名称
查询厂商信息
使用者
查询厂商信息维护人员
说明
操作者通过此操作进行查询厂商信息的筛选查询
先决条件
操作着拥有查询查询厂商信息的权限
运行结果
根据填写条件筛选出查询厂商信息并刷新列表
一般流程
用户操作
1.填写查询条件：
厂商编号、厂商名称、所属类别、备注。
3.点击查询按钮。
系统响应
2.校验查询条件是否符合校验规则。
4.根据查询条件对查询厂商信息进行筛选并刷新列表展示。
可选流程
例外情况
1.如果厂商编号不符合校验规则，则红线提示，点击查询按钮会清空不符合规则的厂商编号。
特定需求
1.厂商编号只允许为数字
升级会员 