详细设计模板(防壳牌版).doc

Project XYZDetailed Solution Technical DesignDetailed Solution Technical DesignProject Name: Date: Application Name:Project Identifier: Sponsoring Business:Project Manager: Version Number:Version NumberDraft/Final as of:DatePrinted on: DateAuthorAuthors NameAddressE-mailOwnerOwners NameApproval SignaturesNameTitleRevision HistoryDateVersionAuthorReviewed ByChange Description1.Table of ContentsDetailed Solution Technical Design1Revision History1Table of Contents21.Overview概述41.1.Background41.2.Project Objective41.3.Design Considerations设计考虑要素41.4.Design Constraints and Trade-offs设计限制及权衡42.Plant Database Design数据库设计52.1.数据表索引52.2.ER图52.3.数据库结构详细说明62.3.1.T_SHELL_PLANT_PARAMETER 参数表62.3.2.T_SHELL_PLANT_REG正则表达式表63.Plant System Design系统设计73.1.Re-use Statement 重复使用说明83.1.1.开发环境83.1.2.目录构成93.1.3.Logs (日志)主要罗列公用方法93.1.4.生产数据文件命名规范：93.1.5.Error Handling 错误处理93.2.Barcode Workstation Config Management (参数管理)10Application Module Definition应用模块定义10User Interface / Screen Designs 用户界面/屏幕设计14Menu Network / Screen Navigation 菜单网络、屏幕导航23Error Handling 错误处理233.3.24Application Module Definition应用模块定义24User Interface / Screen Designs 用户界面/屏幕设计24Menu Network / Screen Navigation 菜单网络、屏幕导航【略】24Error Handling 错误处理243.4.Information Security and Compliance243.5.Help System 帮助系统243.5.1.FAQs & Known Errors (常见问题解答及已知错误清单)243.5.2.User Guide (使用指南)241. Overview概述1.1. Background1.2. Project Objective1.3. Design Considerations设计考虑要素 需求吻合性： 系统性能 系统安全性考虑 系统运行可管理性考虑 系统架构考虑1.4. Design Constraints and Trade-offs设计限制及权衡暂无2. Plant Database Design数据库设计2.1. 数据表索引序号表名说明1T_SHELL_PLANT_PARAMETER参数表，主要是用户配置参数2T_SHELL_PLANT_REG正则表达式表3T_SHELL_PLANT_DICT字典表，主要是系统调用的参数4T_SHELL_PLANT_USER用户表5T_SHELL_PLANT_POWER用户角色关联表6T_SHELL_PLANT_ROLE角色表7T_SHELL_PLANT_RIGHT权限表8T_SHELL_PLANT_MODEL模块表9T_SHELL_PLANT_WARINGTYPE预警日志类别与角色关联关系表10T_SHELL_PLANT_LOG日志表11T_SHELL_PLANT_P生产关联数据表12T_SHELL_PLANT_PHISTORY历史生产关联数据表13T_SHELL_PLANT_PSTATE生产状态表14T_SHELL_PLANT_RANDEM箱条码随机数表2.2. ER图2.3. 数据库结构详细说明2.3.1. T_SHELL_PLANT_PARAMETER 参数表用途：此数据表中包含多条记录，每条记录对应一条参数配置值。表中RegNo编号和T_SHELL_PLANT_REG的RegNo关联，RegNo编号为空代表不需要做正则验证。序号列名数据类型长度小数位自动编号主键允许空默认值说明1ID长整型是是否自动编号2ParameterCode文本4否否否参数编号3ParameterValue备注否否否参数值4RegNo文本4否否是正则表达式编号5ParameterInfo备注否否是参数说明2.3.2. T_SHELL_PLANT_REG正则表达式表用途： 本表是记录本系统所有的数据验对的正则表达式。由开发人员在实际的开发过程中手动维护。序号列名数据类型长度小数位自动编号主键允许空默认值说明1ID长整型是是否自动编号2RegNo文本4否否否正则表达式编号3RegName备注否否是表达式说明4RegValue文本250否否否正则表达式值3. Plant System Design系统设计系统框架图Barcode workstation功能列表：序号No.模块Module子模块Sub Module说明Description对应sow功能1参数配置管理硬件设备参数配置管理主要是相关配置参数的管理FR.BAR.027工厂信息类参数配置管理主要是工厂类参数的管理FR.BAR.027FR.BAR.0232用户管理用户管理添加用户，修改用户，删除用户重置密码，锁定，解锁FR.BAR.026FR.BAR.024FR.BAR.025登录退出修改密码密码定期更新策略3角色管理角色管理修改角色查询角色角色权限分配4生产控制管理设备检测I/O卡的检测（输入输出信号和三色指示灯）FR.BAR.027扫描设备（barcode scanner和check scanner）喷印设备检测网络检测生产录入控制用于校验生产所输入的信息（filling order number、GSAP BATCH NUMBER、两遍产品代码）FR.BAR.001生产管理TAC物流码与箱条码的关联关系控制FR.BAR.002FR.BAR.003FR.BAR.005FR.BAR.006FR.BAR.018FR.BAR.007箱条码的喷印命令按钮控制状态监控运行状态监控设备状态监控FR.BAR.015生产状态监控（KPI和扫描数量及不合格箱数）数据报警主要是根据生产状态做相应的报警FR.BAR.0045数据容错管理补喷容错主要是破箱补喷或者喷印质量不合格补喷（生产结束后班后整理前使用，可根据单品进行查询箱条码）FR.BAR.017FR.BAR.016FR.BAR.004简单容错根据箱条码或TAC物流码解除一箱的关联关系终极容错主要是针对大批量的箱与单品关系的解除灾难数据恢复主要是系统破坏灾难数据恢复数码关系查询主要是查询单品与箱的关系是否正确中性码容错一箱中有一个条码未被扫描出且符合扫描验证规则时该条码被系统自动计为中性码6数据保存生产线数据保存一月在数据库中FR.BAR.0297数据库管理系统在班后整理后对数据库进行压缩修复操作以便保证数据库的大小不过于膨胀8历史数据查询通过TAC物流码、箱物流码对已经归档保存的生产线数据进行查询（在一月时间内）FR.BAR.0309文件转移模块当数据文件上传失败时可以此功能将barcode workstation上的文件复制到外置U盘，此时在复制的同时会自动备份文件至归档目录 并记录日志FR.BAR.02710日志管理用户登录日志记录登录，退出FR.BAR.038数据传输日志记录数据传输失败日志查询（提供页面查询）包含登录失败、数据上传失败； 操作类日志记录系统启动、暂停、结束、数据纠错、补码、对用户的管理操作（新增、修改、删除）、参数修改系统异常日志记录系统异常、硬件监测异常11补喷功能针对外仓可能存在的箱条码破损不能进行扫描但可以辨识数字的箱条码提供的补喷功能，此时箱条码可能已经超过一个月的保存期；此功能根据操作人员的输入的内容进行补喷；3.1. Re-use Statement 重复使用说明3.1.1. 开发环境开发工具：Microsoft Visual Studio 2010运行系统：Microsoft Windows XP简体中文专业版操作系统开发数据库：Microsoft ACCESS 2010运行环境：Microsoft .NET Framework 43.1.2. 目录构成:：程序根目录，存放了应用程序以及相应的应用组件和数据库文件: log：系统日志文件路径: logdeletelog：系统删除日志导出文件备份路径D:datawork：班后整理后数据上传Plant Workstation前的文件存放位置（默认）D:databack：上传Plant Workstation后上传文件备份目录（默认）D:databackback：数据文件上传Plant Workstation失败后，线长使用U盘通过文件转移功能复制到U盘后的数据备份目录（默认）3.1.3. Logs (日志)主要罗列公用方法3.1.4. 生产数据文件命名规范：【coden】+【_】+【工厂编号（shell定义的4位字符）】+【_】+【生产线号】+【_】+【产品编码】+【_】+【年月日时分秒】 +.txt】 例如：coden_C026_01_9292929292_20110708145303.gz生产数据文件内容格式（未压缩的文件内容）：Filling order number, GSAP Batch Number,产品编号,工厂编号（shell定义的4位字符）,生产线号TAC物流码1,箱物流码1,生产时间1TAC物流码2,箱物流码1,生产时间2TAC物流码3,箱物流码1,生产时间3TAC物流码4,箱物流码1,生产时间4TAC物流码5,箱物流码2,生产时间5TAC物流码6,箱物流码2,生产时间6第一行为一个文件共用的信息分别为：Filling order number, GSAP Batch Number,产品编号, 工厂编号（shell定义的4位字符）,生产线号；每项中间以英文半角逗号（，）分隔；第二行向后的信息为： TAC物流码、生产时间、箱物流码三者的关联关系；每项中间以英文半角逗号(，)分隔；生成文件的存放位置正式文件放存于系统的根目录下面的datawork目录，备份文件存放于系统根目录下面的databack目录3.1.5. Error Handling 错误处理1、 数据库操作错误编号错误类型记录数据内容E001数据库文件无法找到时间，错误代码，描述E002数据库无法连接时间，错误代码，描述E003数据插入异常时间，错误代码，描述(包括Sql语句)E004数据更新异常时间，错误代码，描述(包括Sql语句)E005数据删除异常时间，错误代码，描述(包括Sql语句)E006数据查询异常时间，错误代码，描述(包括Sql语句)E007其他数据库操作异常时间，错误代码，描述(异常详细描述)2、 其他错误错误类型处理方式记录数据内容未识别的异常( E101)记录错误日志，系统界面上弹出提示信息时间，错误代码，描述(异常详细描述)3、 错误码段划分模块类型开始结束用户管理模块E200E299参数管理模块E300E399生产管理模块E400E550容错管理模块E551E599数据查询管理模块E600E650文件转移模块E651E700日志管理模块E701E750其他类库公用部分E000E1993.2. Barcode Workstation Config Management (参数管理)系统只有相应的角色才能使用本模块，不同的角色能控制的模块略有不同，对于低权限的角色可以看到高权限控制部分，如果操作员想要控制高权限的部分，就需要切换高权限模块的时候输入用户名和密码即可完成权限的切换，切换后用户就可以对相应的模块进行配置 ，配置完成后系统将会这次恢复到原始的权限状态。切换后的权限仅在参数管理模块生效，整个参数设置和切换角色部分系统将会记录相应的日志。从而方便后期查询。Application Module Definition应用模块定义本功能主要分为四个模块：企业信息管理，系统控制，设备控制，输入输出控制四个模块。四个模块分别对应不同的角色才能操作，具体的对应关系如下：线长：设备控制，输入输出控制Data Support：企业信息管理，为了方便Data Support调试，其可以调整所有的配置点，系统管理员：系统控制 对于同一账户多种角色的时候本模块按照权限叠加的方式处理。数据项目数据格式关联数据表关联字段存储逻辑（对应代码）FacId4位字符，数字+字母t_shell_plant_parameterParameterValue1001FacCode1位0-9数字t_shell_plant_parameterParameterValue1002ProductLine2位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1004数码表代码4位，0-9数字t_shell_plant_parameterParameterValue1003BarCodeLength12位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1005ErrTitle最长20个字符，可输入汉字，字母，数字，空格，_,-t_shell_plant_parameterParameterValue1007国家代码1位，0-9数字t_shell_plant_parameterParameterValue1006应用程序标题不能为空t_shell_plant_parameterParameterValue1008产品编号正则表达式不能为空t_shell_plant_parameterParameterValue1009KPI停线标志True 或者 False；默认为Truet_shell_plant_parameterParameterValue1101一箱1个以上扫描不到停线标志Ture 者 False默认为Truet_shell_plant_parameterParameterValue1102连续三箱都各有一个TAC物流码没有被成功读取标志Ture 或者 False默认为Truet_shell_plant_parameterParameterValue1103Checkscanner报警是否停线标志Ture 或者 False默认为Truet_shell_plant_parameterParameterValue1104SaveFilePath标准的文件路径格式t_shell_plant_parameterParameterValue1105RemoteSavePath标准的文件路径格式t_shell_plant_parameterParameterValue1106ServerIP标准的IP格式t_shell_plant_parameterParameterValue1107UserName字母数字和符号格式t_shell_plant_parameterParameterValue1108password字母数字和符号格式t_shell_plant_parameterParameterValue1109密码有效期（天）2位0-9的数字，范围为1-31，默认30天t_shell_plant_parameterParameterValue1110密码预警期（天）2位0-9的数字，范围为1-31，默认7天，此值应小于密码有效期t_shell_plant_parameterParameterValue1111密码超期限定期（天）2位0-9的数字，范围为1-31，默认10天t_shell_plant_parameterParameterValue1113KPI计算范围数量设定（箱数量）默认390箱t_shell_plant_parameterParameterValue1112Check scanner连续扫描不合格数量（箱数量）默认1箱t_shell_plant_parameterParameterValue1114连续多少箱扫描3个报警默认3箱t_shell_plant_parameterParameterValue1115ScalePort1位定长,仅允许输入数字0-9 (唯一性，不能跟喷码机端口和检测扫描头端口重复)t_shell_plant_parameterParameterValue1201ScaleSetting4800或9600或115200t_shell_plant_parameterParameterValue1202PrintPort1位定长,仅允许输入数字0-9 (唯一性，不能跟箱内端口和检测扫描头端口重复)t_shell_plant_parameterParameterValue1205PrintSetting4800或9600或115200t_shell_plant_parameterParameterValue1206CheckScalePort1位定长,仅允许输入数字0-9(唯一性，不能跟箱内端口和喷码机端口重复)t_shell_plant_parameterParameterValue1203CheckSetting4800或9600或115200t_shell_plant_parameterParameterValue1206写IO卡的位置1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1301写IO卡的位置1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1302读IO卡的位置1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1303单品实物节拍信号1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1304喷码机送码节拍信号1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1305TAC单品扫描报警的红灯引脚1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1306TAC单品扫描报警的黄灯引脚1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1307TAC单品扫描报警的绿灯引脚1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1308CheckScanner扫描报警的红灯引脚1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1309停线标记引脚1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1310开启扫描器引脚1位定长,仅允许输入数字0-9t_shell_plant_parameterParameterValue1311 其对于的流程图如下：1.打开界面前，首先判断操作员角色类别，然后根据角色类别显示相关tab子页面。 2.用户选择要修改的参数，输入后系统自动按照参数顺序进行判断。 3.判断参数的时候首先判断输入的参数值是否为空，如果为空，则跳出判断，直接提示：”参数不能为空,请先输入”.并清空该输入框，然后将焦点移回到该输入框中。 4.如果不为空，则在参数表里面查询其是否有对应的正则编号值，如果没有，则调用SQL注入验证方法判断其是否含有注入的敏感字，如果有，则提示”参数非法,请先输入”.并清空该输入框，然后将焦点移回到该输入框中。如果没有则验证通过，继续判断其它的参数。 查找正则的SQL语句：select regno from t_shell_plant_parameter where parametercode=05.如果有对应的正则表达式标号，则在T_SHELL_PLANT_REG正则表达式中查找该编号对应的正则表达式字符串，如果没有找到，则提示：”正则参数丢失,请与管理员联系”.并退出整个程序。6.如果找到则调出其正则表达式字符串，然后根据正则编号调用重复部分的正则验证方法判断起是否有效。如果无效，则直接提示：”参数不符合规则,请重新输入”.并清空该输入框，然后将焦点移回到该输入框中。 查找对应的SQL语句为:select regvalue from t_shell_plant_reg where regno=0 5.继续重复3，4部分，判断其它参数是否符合规格，当页面中所有的参数验证完毕后，按顺序修改参数表的数据，修改的时候首先根据参数编号在t_shell_plant_reg参数表中查询是否存在，如果存在，则直接Update更新，如果不存在，则执行Insert插入即可。 Insert插入对应的SQL语句为： insert into t_shell_plant_parameter (parametercode,parametervalue,regno,parameterinfo) values(0,1,2,3) Update更新对应的SQL语句为: update t_shell_plant_parameter set parametervalue=1 , regno=2, parameterinfo=3 where parametercode=0User Interface / Screen Designs 用户界面/屏幕设计Data Support登录后的参数管理界面【具体工厂参数值可能若有 不同】。系统管理员登录后的只能操作系统控制的参数管理界面，当点击等非直属权限页面时(如【设备控制】页)，需要更换用户。登录通过后就可以修改参数，修改完毕后又恢复到原始角色。线长登录后的可以操作设备控制，输入输出控制的参数管理界面，当点击等非直属权限页面时(如【系统控制】页)，需要更换用户。登录通过后就可以修改参数，修改完毕后又恢复到原始角色。界面元素项目 类型文字字体/图片大小操作类型数据来源对应数据表及字段tabControl1选项卡tabControl宋体, 9pt，White显示程序固化Tabpage1页面控件Tabpage企业信息管理724, 68显示程序固化Tabpage2页面控件Tabpage系统控制宋体, 9pt，ControlText显示程序固化Tabpage3页面控件Tabpage设备控制宋体, 9pt，ControlText显示程序固化Tabpage4页面控件Tabpage输入输出控制宋体, 9pt，ControlText显示程序固化Gasp工厂编号标签LabelGasp工厂编号宋体, 9pt，ControlText显示程序固化生产工厂编号标签Label生产工厂编号宋体, 9pt，ControlText显示程序固化数据表代码标签Label数据表代码宋体, 9pt，ControlText显示程序固化生产线号代码标签Label生产线号代码宋体, 9pt，ControlText显示程序固化TAC物流码长度标签LabelTAC物流码长度宋体, 9pt，ControlText显示程序固化国家代码标签Label国家代码宋体, 9pt，ControlText显示程序固化消息框提示标题标签Label消息框提示标题宋体, 9pt，ControlText显示程序固化应用程序标题标签Label应用程序标题宋体, 9pt，ControlText显示程序固化产品验证使用正则表达式标签Label产品验证使用正则表达式宋体, 9pt，ControlText显示程序固化Gasp工厂编号输入框TextBox宋体, 9pt，ControlText显示参数表生产工厂编号输入框TextBox宋体, 9pt，ControlText显示参数表数据表代码输入框TextBox宋体, 9pt，ControlText显示参数表生产线号代码输入框TextBox宋体, 9pt，ControlText显示参数表TAC物流码长度输入框TextBox宋体, 9pt，ControlText显示参数表国家代码输入框TextBox宋体, 9pt，ControlText显示参数表消息框提示标题输入框TextBox宋体, 9pt，ControlText显示参数表应用程序标题输入框TextBox宋体, 9pt，ControlText显示参数表产品验证使用正则表达式输入框ComboBox宋体, 9pt，ControlText显示参数表保存按钮Button保存宋体, 9pt, style=Bold，Navy点击程序固化退出按钮Button退出宋体, 9pt, style=Bold，Navy点击程序固化KPI停线标准标签LabelKPI停线标准宋体, 9pt，ControlText显示程序固化联系三箱各1个读取失败停线标志标签Label联系三箱各1个读取失败停线标志宋体, 9pt，ControlText显示程序固化一箱内大于1个读取失败停线标准标签Label一箱内大于1个读取失败停线标准宋体, 9pt，ControlText显示程序固化本地备份路径标签Label本地备份路径宋体, 9pt，ControlText显示程序固化远程目录映射地址标签Label远程目录映射地址宋体, 9pt，ControlText显示程序固化远程服务器密码标签Label远程服务器密码宋体, 9pt，ControlText显示程序固化远程服务器帐号名标签Label远程服务器帐号名宋体, 9pt，ControlText显示程序固化远程总控机IP标签Label远程总控机IP 宋体, 9pt，ControlText显示程序固化密码有效期（天）标签Label密码有效期（天）宋体, 9pt，ControlText显示程序固化密码预警期（天）标签Label密码预警期（天）宋体, 9pt，ControlText显示程序固化密码超期限（天）标签Label密码超期限（天）宋体, 9pt，ControlText显示程序固化KPI计算范围数量设定（箱数量）标签LabelKPI计算范围数量设定（箱数量）宋体, 9pt，ControlText显示程序固化KPI停线标准单选按钮radioButton启用宋体, 9pt，ControlText显示程序固化KPI停线标准单选按钮radioButton禁用联系三箱各1个读取失败停线标志单选按钮radioButton启用宋体, 9pt，ControlText显示程序固化联系三箱各1个读取失败停线标志单选按钮radioButton禁用程序固化一箱内大于1个读取失败停线标准单选按钮radioButton启用宋体, 9pt，ControlText显示程序固化一箱内大于1个读取失败停线标准单选按钮radioButton禁用程序固化本地备份路径输入框TextBox宋体, 9pt，ControlText显示参数表远程目录映射地址输入框TextBox宋体, 9pt，ControlText显示参数表远程服务器密码输入框TextBox宋体, 9pt，ControlText显示参数表远程服务器帐号名输入框TextBox宋体, 9pt，ControlText显示参数表远程总控机IP输入框TextBox宋体, 9pt，ControlText显示参数表密码有效期（天）数字输入框numericUpDown0宋体, 9pt，ControlText显示程序固化密码预警期（天）数字输入框numericUpDown0宋体, 9pt，ControlText显示程序固化密码超期限（天）数字输入框numericUpDown0宋体, 9pt，ControlText显示程序固化KPI计算范围数量设定（箱数量）数字输入框numericUpDown0宋体, 9pt，ControlText显示程序固化保存按钮Button保存宋体, 9pt, style=Bold，Navy点击程序固化退出按钮Button退出宋体, 9pt, style=Bold，Navy点击程序固化箱内扫描头端口号标签Label箱内扫描头端口号：宋体, 9pt，ControlText显示程序固化箱内扫描头波特率标签Label箱内扫描头波特率：宋体, 9pt，ControlText显示程序固化CheckScanner端口号标签LabelCheckScanner端口号：宋体, 9pt，ControlText显示程序固化CheckScanner波特率标签LabelCheckScanner波特率：宋体, 9pt，ControlText显示程序固化喷码机端口号标签Label喷码机端口号：宋体, 9pt，ControlText显示程序固化喷码机波特率标签Label喷码机波特率：宋体, 9pt，ControlText显示参数表箱内扫描头端口号下拉框ComboBox宋体, 9pt，ControlText显示参数表箱内扫描头波特率下拉框ComboBox宋体, 9pt，ControlText显示参数表CheckScanner端口号下拉框ComboBox宋体, 9pt，ControlText显示参数表CheckScanner波特率下拉框ComboBox宋体, 9pt，ControlText显示参数表喷码机端口号下拉框ComboBox宋体, 9pt，ControlText显示参数表喷码机波特率下拉框ComboBox宋体, 9pt，ControlText显示参数表保存按钮Button保存宋体, 9pt, style=Bold，Navy点击程序固化退出按钮Button退出宋体, 9pt, style=Bold，Navy点击程序固化IO卡的物理位置：LabelIO卡的物理位置：宋体, 9pt，ControlText显示程序固化写IO卡的位置标签Label写IO卡的位置标签宋体, 9pt，ControlText显示程序固化读IO卡的位置标签Label读IO卡的位置标签宋体, 9pt，ControlText显示程序固化单品实物节拍信号标签Label单品实物节拍信号标签宋体, 9pt，ControlText显示程序固化喷码机送码节拍信号标签Label喷码机送码节拍信号标签宋体, 9pt，ControlText显示程序固化TAC单品扫描报警的红灯引脚标签LabelTAC单品扫描报警的红灯引脚标签宋体, 9pt，ControlText显示程序固化TAC单品扫描报警的黄灯引脚标签LabelTAC单品扫描报警的黄灯引脚标签宋体, 9pt，ControlText显示程序固化TAC单品扫描报警的绿灯引脚标