C系统详细设计说明书.docx
《C系统详细设计说明书.docx》由会员分享，可在线阅读，更多相关《C系统详细设计说明书.docx（69页珍藏版）》请在冰豆网上搜索。
C系统详细设计说明书
文件编号：
食品安全数据分析与风险评估系统
软件详细设计说明书
版本
二零一四年四月
文档修改记录表
创建人
创建时间
当前版本
备注
万勇韬
修改人
修改时间
当前版本
修改内容
引言
编写目的
项目背景
使用范围
定义与缩略语
参考资料
软件功能和结构
软件功能
软件设计结构
首页模块设计说明
首页设计说明
功能概述
业务操作流程
画面迁移图
功能画面
主要程序逻辑
内部接口
数据库
限制条件
尚未解决的问题
评估报告详细设计
评估报告检索设计说明
功能概述
业务操作流程
画面迁移图
功能画面
主要程序逻辑
内部接口
数据库
限制条件
尚未解决的问题
引言
编写目的
本详细设计说明书是针对食品安全数据分析与风险评估系统编写而编写。
目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构。
详细地介绍系统的各个模块，为进行后面的实现和测试做准备。
项目背景
）建设食品安全风险评估基础数据库，依托居民营养健康调查数据、污染物监测数据、微生物监测数据、海关农产品进出口检测数据、中国居民饮料酒饮料消费状况调查数据、总膳食调查数据、毒理学数据库进行建设。
本项目完成：
）依托年居民营养健康调查数据，从中抽取人口学信息（性别、年龄、体重等）和膳食消费量信息，构建食品安全风险评估所需的食物消费量数据库；
）依托污染物监测数据库，从中抽取食物中污染物含量数据，构建污染物含量数据库。
）通过统一的食物编码建立食物消费量信息和污染物含量信息之间的关联关系。
）提供数据探索分析功能。
）评估报告管理，提供评估报告的著录、检索和简单统计汇总功能，实现报告信息在评估部门内部范围的共享。
使用范围
本系统设计说明书的预期读者为本项目相关研发人员及对该项目进行扩展和维护的人员。
系统主要用户为评估部门工作人员，并预留向其他部门用户开放的接口，供评估中心领导和其他部门员工查看信息。
定义与缩略语
.本文中所使用的术语“报告”，特指“评估报告”，根据上下文，可能表示纸质或电子版的“评估报告”；
.本文中所使用的术语“报告记录”，特指“评估报告”登记入库时的著录信息，如：
“报告名称”、“关键字”等。
.所有删除操作，均为伪操作，即仅对目标记录作删除标记，不予显示，评估报告记录删除时，关联关系要保留。
必要时可恢复。
.关联属性成对出现，建立报告之间的关联关系时，同时建立反向关联。
.评估报告的标识字段，目前手工录入，系统作唯一性校验。
参考资料
软件功能和结构
软件功能
基础数据库管理
数据采集功能
包括
）外部常用数据库单点登录，对于不提供数据层和应用层接口的数据源，提供单点登录快捷访问连接地址，地址数目不限，以满足最终用户的实际需求为准；
）对于内部常用数据源，本项目提供数据批量入库功能；
数据批量入库
提供数据批量导入程序，将整理好符合固定格式要求的食物消费量数据（本项目限于居民营养与健康状况监测数据）和危害因素数据（本项目限于污染物、微生物和食品添加剂的监测数据）一次性导入基础数据库，要求输入文件格式为。
数据探索分析
包括
）组合查询，针对所有可用数据表字段的自定义组合查询及结果展示；
）数值分析，针对所有数值型字段，提供极值（最大、最小值）、求和、算术平均值、中位数、百分位数等分析功能。
）分组查询，针对食物消费量数据提供按地域、年龄、性别、体重等进行分组查询统计的功能；针对污染物监测数据提供按食物类别、包装类别、采集地点类型、样本产地进行分组查询统计的功能，其中食物类别、采集地点类型、样本产地，要求支持分级分组统计，采样日期和检测日期支持按年和月两级分组统计。
提供分组结果的图形化展示（饼图、直方图等）。
）维度定义，附录中所列数据项，带*为分组统计分析常用维度，要求所有带层次的维度支持自动分级；数值字段用于维度时，允许手工对值域进行分段（如，按[年龄]分组，可以自定义“岁：
婴幼儿组；岁：
幼儿组；岁：
少年组”等等）。
数据导出
将数据探索分析过程中生成的临时结果数据以表的形式导出。
数据备份恢复
提供定时和手动数据库备份功能，提供备份恢复功能。
评估报告管理
评估报告著录管理
按照附录要求数据项，对评估报告进行逐项登记，并保存到数据库，包括把报告的相应电子档（文档、等）上传并保存到数据库服务器。
评估报告检索管理
按照用户输入的查询条件，在数据库中查找符合条件的纪录，并返回结果。
统计汇总
实现按主题、类别等进行分组统计汇总的功能。
数据字典管理
提供数据字典维护功能。
用户及权限管理
提供灵活的用户及权限设置，提供基于角色的权限控制；提供用户、角色和操作之间的对应关系管理，操作包括所有菜单级操作，登录操作无限制。
软件设计结构
首页模块设计说明
此模块完成首页展示及导航功能。
首页设计说明
功能概述
首页模块主要提供展示和导航功能。
用户可以在首页查看实时动态，专项调查，外部数据库，评估报告，专业数据库的部分内容，也可以点击【更多】查看对应栏目的信息列表。
用户可以在首页导航栏进入相关模块。
业务操作流程
后台：
1．用户登陆后，进入首页，查看实时动态，专项调查，外部数据库，评估报告，专业数据库的部分内容，
2．用户可以点击【更多】查看对应栏目的信息列表；
3．用户点击导航栏，进入相关模块页面；
相关限制条件及情况判断见第节功能画面介绍。
画面迁移图
首页画面迁移图
功能画面
⏹：
后台首页
1界面效果图
界面上方为导航区：
分为首页，新闻，评估报告管理，基础数据库管理，关于我们和系统管理。
界面中部为数据列表区：
展示实时动态列表，专项调查列表，外部数据库列表，评估报告列表，专业数据库列表。
界面下方为声明区：
展示网站基本信息。
2界面功能说明：
无
主要程序逻辑
无
内部接口
时间事件
请求
参数
返回值
备注
进入首页
跳转
评估报告检索
跳转
评估报告著录
跳转
评估报告维护
跳转
常用数据地址管理
跳转
批量数据导入
跳转
数据探索分析
跳转
用户管理
跳转
角色和权限管理
跳转
数据字典管理
跳转
系统配置
跳转
数据库
通用字段（创建人、创建时间、创建、修改人、修改时间、修改）略
限制条件
用户必须登陆
尚未解决的问题
评估报告详细设计
此模块完成评估报告管理。
各子模块中公用的界面部分有——
✓列表页的查询区按钮：
【查询】【清空】按钮
✓列表页的翻页区：
首页末页、上页下页及页码跳转的功能
✓日期和时间控件
公用的操作提示有——
错误
错误类型
发生时间
发生条件
错误内容
提示
查询、保存等功能按键按下时
必要信息均没有输入
请填写必填信息
提示
添加、编辑、删除及查看等操作按键按下时
未选中数据
请选择数据
提示
删除按键按下时
点击删除按钮
提示是否删除选中数据
提示
编辑、查看按键按下时
选中数据多于一条
请选择一条数据进行操作
评估报告检索设计说明
功能概述
此模块主要针对于用户。
用户在此模块可以按照提供的条件查询评估报告，并且下载评估报告文件。
业务操作流程
1．用户登陆后，进入评估报告检索页，执行查询操作；
2．填写查询条件之后，点击【检索】，跳转到检索结果页
3．检索结果列表，每一条检索报告信息，均可以下载报告。
4．点击【返回】，跳转回检索页面，进行重新检索。
画面迁移图
评估报告检索画面迁移图
功能画面
⏹：
评估报告检索页
1界面效果图
界面上方为导航区
界面中间为检索区：
检索条件为题名，主题，类型，日期范围；日期分为创建日期，发布日期，著录日期和最后修改时间。
界面左上部为数据库简介。
界面左下部为外部共享数据库链接列表。
界面右部为评估报告统计区：
展示按照类型统计数据。
②界面功能说明：
展示部件见上方效果页，相关通用功能不变，需要说明的有：
1．搜索题名长度有限制（中文最大长度位），主题长度有限制（中文最大长度位）。
2．类型数据来自数据字典。
分类为评估报告分类。
每一个评估报告仅能属于一个类型。
3．日期范围分为四类：
创建日期，发布日期，著录日期和最后修改时间。
输入由时间控件控制。
4．点击模糊查询，可以进行模糊查询。
5．点击【重置】，可以置空所有输入信息。
6．点击【检索】进行检索。
⏹：
检索结果列表页
1界面效果图
②界面功能说明：
展示部件见上方效果页，相关通用功能不变，需要说明的有：
1．检索结果列表上方统计检索结果条数。
2．点击评估报告题名，可以下载评估报告。
3．检索结果列表下方为翻页操作。
4．数据列表按顺序显示为：
{序号，标识符，题名，主题，创建者，发布日期，类型}，其中超过列宽的只显示部分内容
5．选择“返回”时，返回到评估报告检索页
⏹：
统计汇总列表页
1界面效果图
②界面功能说明：
展示部件见上方效果页，相关通用功能不变，需要说明的有：
1．所有主题进行分类统计，节点下有子节点均可以统计
主要程序逻辑
1.评估报告存于表，评估报告类型信息存于表，两表之间为。
内部接口
时间事件
请求
参数
返回值
备注
打开检索页
检索
{;;;;:
;:
;:
}
对象的
返回
数据库
通用字段（创建人、创建时间、创建、修改人、修改时间、修改）略
表
表名
评估报告信息表
字段名
字段名
类型
说明
是否必填
（）
是
题名
是
创建者
是
主题
是
描述
否
出版者
否
其他责任者
否
类型
（）
数据字典
是
格式
（）
数据字典
是
创建日期
否
发布日期
著录日期
修改日期
评估文件
文件地址
是
标示符
否
语言
（）
数据字典
否
空间范围
数据字典
否
时间范围起
否
时间范围止
否
权限声明
否
状态
（）
数字禁用
否
创建者用户名
是
创建者
是
创建时间
是
修改者用户名
否
修改者
否
修改时间
否
扩展字段
否
扩展字段
否
扩展字段
否
扩展字段
（）
否
扩展字段
（）
否
扩展字段
否
限制条件
尚未解决的问题
评估报告著录设计说明
功能概述
此模块主要针对于用户。
用户在此模块可以按照要求录入评估报告信息。
业务操作流程
1．用户登陆后，进入评估报告著录页，执行著录操作。
2．填写著录信息之后，点击【保存】，暂存未完成的著录信息，供以后继续该操作。
3．点击【提交】，将校验成功的记录保存到数据库，包括将报告电子档上传服务器。
并反馈成功提示，继续添加（所有内容清空）。
画面迁移图
评估报告著录画面迁移图
功能画面
⏹：
评估报告著录页
1界面效果图
界面上方为导航区
界面下方为著录区：
②界面功能说明：
展示部件见上方效果页，相关通用功能不变，需要说明的有：
1．题名必填长度有限制（中文最大长度位），主题必填长度有限制（中文最大长度位），创建者必填长度有限制（中文最大长度为），描述非必填项，最大长度为中文，出版者非必填，中文最大长度为，其他责任者非必填，中文最大长度为，日期分为四类，由时间控件控制输入，分类为必填项，数据由数据字典提供。
格式为必填项，数据由数据字典提供。
标识符非必填项，长度为。
来源为必填项，上传文件控件控制。
语种为非必填项，数据来源由数据字典提供。
关联为非必填项，需用户手动收入名称，系统会给出是否存在于数据库。
关联关系数据由数据字典提供。
空间覆盖为非必填，数据来源于数据字典，可选多个。
时间覆盖为非必填项。
由时间控件控制。
权限声明为非必填字段，最大长度为.
2．类型数据来自数据字典。
分类为评估报告分类。
每一个评估报告仅能属于一个类型。
3．日期范围分为四类：
创建日期，发布日期，著录日期和最后修改时间。
输入由时间控件控制。
4．一个评估报告可以有多个关联关系，点击【添加新关联】，可以添加新的关联信息。
5．点击【保存】将评估报告保存。
6．点击【提交】将评估报告提交。
主要程序逻辑
1.评估报告存于表，评估报告类型信息存于表，两表之间为。
2.评估报告存于表，关联信息信息存于表，两表之间为。
内部接口
时间事件
请求
参数
返回值
备注
著录页
保存
提交
数据库
通用字段（创建人、创建时间、创建、修改人、修改时间、修改）略
表
表名
评估报告信息表
字段名
字段名
类型
说明
是否必填
（）
是
题名
是
创建者
是
主题
是
描述
否
出版者
否
其他责任者
否
类型
（）
数据字典
是
格式
（）
数据字典
是
创建日期
否
发布日期
著录日期
修改日期
评估文件
文件地址
是
标示符
否
语言
（）
数据字典
否
空间范围
数据字典
否
时间范围起
否
时间范围止
否
权限声明
否
状态
（）
数字禁用
否
创建者用户名
是
创建者
是
创建时间
是
修改者用户名
否
修改者
否
修改时间
否
扩展字段
否
扩展字段
否
扩展字段
否
扩展字段
（）
否
扩展字段
（）
否
扩展字段
否
限制条件
尚未解决的问题
评估报告维护设计说明
与著录基本相同，参看上一节。
基础数据库设计说明
常用数据源地址管理设计说明
功能概述
此模块主要针对于管理员。
管理员在此模块可以按照要求管理常用数据源地址。
业务操作流程
1．用户登陆后，进入常用数据源地址页，执行操作。
2．填写著录信息之后，点击【保存】，保存该常用数据源地址。
3．选中某条数据源地址信息，可以进行修改和删除操作。
4．用户在指定页面点击该数据源地址，即可以直接登录，不需要填写账号和密码。
画面迁移图
常用数据源地址管理画面迁移图
功能画面
⏹：
常用数据源地址列表页
1界面效果图
2界面功能说明：
无
⏹：
常用数据源地址添加页
1界面效果图
2界面功能说明：
.数据源名称必填，长度有限制，最大长度为.数据源简介为非必填项，最大长度为.网址为必填项，最大长度为.登录服务地址为非必填项，最大长度为，登录账号和密码为非必填项，但两者必须同时填写。
最大长度为.
主要程序逻辑
内部接口
时间事件
请求
参数
返回值
备注
常用数据源列表页
对象
新增页
保存
编辑页
明细页
对象
数据库
通用字段（创建人、创建时间、创建、修改人、修改时间、修改）略
表
表名
常用数据源地址信息表
字段名
字段名
类型
说明
是否必填
（）
是
数据源名称
是
数据源简介
否
网址
是
登录地址
否
账户
否
密码
否
排序
（）
否
状态
（）
数字禁用
是
创建者用户名
是
创建者
是
创建时间
是
修改者用户名
否
修改者
否
修改时间
否
扩展字段
否
扩展字段
否
扩展字段
否
扩展字段
（）
否
扩展字段
（）
否
扩展字段
否
限制条件
尚未解决的问题
数据批量导入设计说明
功能概述
此模块主要针对于管理员。
管理员在此模块可以按照要求导入数据探索分析的数据。
业务操作流程
1．管理员登陆后，进入批量数据导入页，执行操作。
2．点击【浏览】，选择要上传的文件。
3．管理员选择需要导入的数据库名称。
4．管理员选择需要导入的数据表名称。
5．管理员选择导入日志的输出路径。
6．点击【导入】数据，进行导入数据的操作。
画面迁移图
批量数据导入画面迁移图
功能画面
⏹：
批量数据导入页
1界面效果图
2界面功能说明：
参照
主要程序逻辑
内部接口
时间事件
请求
参数
返回值
备注
批量数据导入页
导入
数据库
通用字段（创建人、创建时间、创建、修改人、修改时间、修改）略
表
表名
污染物信息表
字段名
字段名
类型
说明
是否必填
（）
是
监测点
（）
监测单位地区
样品编号
食品分类
污染物编码
（）
（）
检测值
（）
商品名称
采样日期*
采样地点
采集地点类型*
样品产地
样品规格
数量单位
样品包装
样品商标
包装类别*
样品生产厂家
样品备注
检测单位
检测日期
浓度单位
检测方法
检测备注
状态
（）
数字禁用
否
创建者用户名
是
创建者
是
创建时间
是
修改者用户名
否
修改者
否
修改时间
否
扩展字段
否
扩展字段
否
扩展字段
否
扩展字段
（）
否
扩展字段
（）
否
扩展字段
否
表名
微生物信息表
字段名
字段名
类型
说明
是否必填
（）
是
监测省份自治区直辖市
样品编号
食品类别*
样品名称
采样日期*
采样地点
采样地点类型*
样品产地*
包装类型*
规格
采样数量
（）
数量单位
生产厂家
流动早餐地点性质*
适用年龄段
样品备注
检测日期*
监测项目*
检测结果
计数结果
计数单位
检测方法定性
检测方法定量
状态
（）
数字禁用
否
创建者用户名
是
创建者
是
创建时间
是
修改者用户名
否
修改者
否
修改时间
否
扩展字段
否
扩展字段
否
扩展字段
否
扩展字段
（）
否
扩展字段
（）
否
扩展字段
否
表名
添加剂信息表
字段名
字段名
类型
说明
是否必填
（）
是
监测省份自治区直辖市*
样品编号
食品类别*
样品名称
采样日期*
采样地点
采样地点类型*
样品产地*
包装类型*
规格
采样数量
（）
数量单位
生产厂家
流动早餐地点性质*
适用年龄段
样品备注
检测日期*
监测项目*
检测结果
计量结果
计量单位
检测方法定性
检测方法定量
状态
（）
数字禁用
否
创建者用户名
是
创建者
是
创建时间
是
修改者用户名
否
修改者
否
修改时间
否
扩展字段
否
扩展字段
否
扩展字段
否
扩展字段
（）
否
扩展字段
（）
否
扩展字段
否
表名
食物消费量信息表
字段名
字段名
类型
说明
是否必填
（）
是
个人编码
是
年龄
（）
数字禁用
是
性别
（）
是
体重
（）
是
是
是否城市
（）
数字否是
是
六类地区*
是
食物编码*
是
消费量
升级会员 