家校通概要设计说明书

TOC\o"1-3"\h\z\u23087软件概要设计说明书 3224441.引言 329811.1编写目的 3315811.2定义 357601.3参考资料 378442.范围 3287342.1系统主要目标 364772.2主要软件需求 4288582.2.1家长需求 4118012.2.2学校需求 4145172.2.3教师需求 5265342.3设计约束、限制 5270602.3.1（数据库）表编号与命名定义 513692.3.2编程规范 686252.3.3注释书写规定 10165783.软件系统结构设计 153713.1复审数据流、控制流 15141123.2软件体系结构 15313713.2.1软件程序结构图 15245473.2.2模块命名规则 15190113.2.3模块描述 15953.3功能需求追溯 21289334.复用策略 21199905.数据设计 22128065.1数据字典复审 22154195.2数据项 2217721业务信息表d_operation_info 2257255.3.数据库结构设计 22301575.4.文件设计 22228736.接口设计 23311836.1.用户界面设计规则 2312926.1.1字体 23296056.1.2控件 23134016.2内部接口设计 24216196.3外部接口设计 24303247.出错处理设计 24201488.系统维护设计 25软件概要设计说明书SoftwarePreliminaryDesignDescription1.引言1.1编写目的在分析《管理信息系统的基础》上，华迪公司Android项目小组对该系统进行了概要设计。主要是基于以下目的编写此说明书。1、对系统概要设计的阶段任务成果形成文档，以便阶段验收、评审，最终的文档验收。2、对需求阶段的文档再次确认过程，对前一阶段需求没有做充分或错误的提出修改。3、明确整个系统的功能框架和数据库结构，为下一阶段的详细设计、编码、和测试提供参考依据。4、明确编码规范和命名规范，统一程序界面。预期读者：详细设计人员、概要设计评审小组、研究院领导。1.2定义MIS:管理信息系统系统:管理信息系统质量技术交底：对一个工程项目开始时提出的要达到的质量要求。人力强度：一个工程项目每个时间段投入人力的分布。1.3参考资料书2.范围2.1系统主要目标华迪家校通（HwadeeFamiliesSchoolCommunication，简写：Hwadee-FSC）是指利用无线通信技术和网络技术搭建的家校互通平台，为家校之间提供充分、准确、及时的沟通方式，为全面监控学生和学生成长提供有效的途径，该平台运行于移动终端，家长、学生、教师、领导都可以通过智能手机、平板电脑等媒介进行沟通和信息传递。2.2主要软件需求2.2.1家长需求2.2.1.1子女情况监控可以通过平台查看学生考勤、奖罚、评语、成绩、学生管理、作业等信息2.2.1.2交流和留言功能能通过文字进行沟通能发送语音进行沟通2.2.1.3具备二维码扫描功能2.2.2学校需求2.2.2.1建立学校微网站所有用户可以查看学校简介、机构设置、通知、公告、新闻等。2.2.2.2与学校现有数据对接将学生的考勤（门禁）、奖罚、评语、成绩、作业信息进行整合。2.2.2.3信息主动推送将学生的考勤、奖罚、评语、成绩、学生管理、作业信息推送给家长。能发布新闻、通知信息，并推送给老师、家长、学生。2.2.3教师需求2.2.2.1作业发布将课后作业信息发送给家长和学生。2.2.2.2信息交流能通过平台与家长、学生进行沟通交流，支持语音。能发布新闻、通知信息，并推送给家长、学生能发布学生活动照片，所有家长均可以浏览和留言。采用高稳定、高扩展性的开发平台，建议使用Liferay平台。客户端支持IOS和Android两种移动操作系统，推荐前期先开发支持Android的移动APP2.3设计约束、限制2.3.1（数据库）表编号与命名定义2.3.1.1表编号定义：9000 a).9 1位，表示表的类型；代表码表代表数据存放表临时表视图2.3.1.2表命名定义：AB_+表的英文名称a).A 表示表的性质，‘无’ 代表用户表（与业务处理直接相关的表）S 代表系统表（为完成业务而建的对用户非透明的表）b).B 表示表的类型，C 码表（包含唯一代码，一次性生成，很少改动）D 数据存放表（业务数据、控制、设置、记录系统信息等）T 临时表（程序动态生成）V 视图c).表的英文名称 表示表的英文名称，可缩写；d).举例 用户码表：c_bank 系统码表：sc_user2.3.2编程规范2.3.2.1对象命名规范对象类型序号项目前缀备注1复选框CbxCheckBox2命令按钮CbCommandButton3数据窗口DwDataWindow4下拉列表框DdlbDropDownListBox5带图标下拉列表框DdplbDropDonwPictureListBox6带格式编辑框EmEdistMask7函数FFunction8函数对象FoFunction_Object9图表GrGraph10分组框GbGroupBox11水平滚动条HsbHScrollBar12线LnLine13列表框LbListBox14列表视图LvListView15菜单MMenu16多行编辑器MleMultiLineEdit17对象公用函数OFObjectFunction18OLE控件OleOLE19椭圆OvalOval20图片PicPicture21图形按钮PbPictureButton22带图标列表框PlbPictureListBox23无线按钮RbRadioButton24矩形RRectangle25超文本编辑器RteRichTextEdit26圆角矩形RrRoundRectangle27对象私有函数SFSystemFunction28单行编辑器SleSingleLineEdit29静态文本StStaticText30标签TabTab31树状视图TvTreeView32用户对象UoUserObject33垂直滚动条VbVscrllBar34窗口WWindow35管道PipePipeLine36工程PProject37代理ProProxy2.3.2.1.1PBL对象命名（类+）对象类型前缀+‘_’+对象英文名如：uo_process_render cw_process_ancestor2.3.2.1.2控件对象命名对象类型前缀+‘_’+对象英文名如：pic_background sle_password2.3.2.2变量命名规范变量类别序号项目前缀备注1全局变量GGlobal2共享变量SShared3实例变量IInstant4局部变量LLocal5远端变量RRemote2.3.2.2.1数据变量类型序号项目前缀备注1任意类型AAny2大数据BlobBlob3布尔型BBoolean4字符型CChar,Character5日期型DDate6时间型TTime7日期时间型DTDateTime8小数型DecDec,Decimal9双精度型DBDouble10整型IInt,Integer11长整型LLong12实型RReal13字符串型SString14无符号整型UIUint,UnsignedInt,UnsignedInteger15无符号长整型ULUlong,UnsignedLong2.3.2.2.2对象变量类型序号项目前缀备注1应用AppApplication2复选框CbxCheckBox3命令按钮CbCommandButton4数据窗口DwDataWindow5下拉列表框DdlbDropDownListBox6带图标下拉列表框DdplbDropDonwPictureListBox7带格式编辑框EmEdistMask8函数对象FoFunction_Object9图表GrGraph10分组框GbGroupBox11水平滚动条HsbHscrollBar12线LnLine13列表框LbListBox14列表视图LvListView15菜单MMenu16多行编辑器MleMultiLineEdit17OLE控件OleOLE18椭圆OvalOval19图片PicPicture20图形按钮PbPictureButton21带图标列表框PlbPictureListBox22无线按钮RbRadioButton23矩形RRectangle24超文本编辑器RteRichTextEdit25圆角矩形RrRoundRectangle26单行编辑器SleSingleLineEdit27静态文本StStaticText28标签TabTab29树状视图TvTreeView30用户对象UoUserObject31垂直滚动条VbVscrllBar32窗口WWindow33连接ConnectionConnection34上下文信息CtinfoContextInformation35上下文关键字CtKeywordContextKeyword36数据存储DsDataStore37动态描述区DdsaDynamicDescriptionArea38动态存储区DsaDynamicStagingArea39错误ErrError40InternetInetInet41Internet结果InetResultInternetResult42邮件会晤层MailsessionMailsession43消息MsgMessage44OLE对象OleObjectOLEOject45OLE存储OleStorageOleStorage46OLE流OleStreamOleStream47管道PipePipeLine48PB对象PboPowerObject49剖面ProfilingProfiling50服务ServiceService51定时器TimingTiming52轨迹树TraceTreeTraceTree53事务TransTransaction54传输TransportTransport2.3.2.2.3变量命名变量类别+数据类型变量/对象类型变量+‘_’+变量英文名如： gs_username lpic_background2.3.3注释书写规定2.3.3.1PBLa).PBL注释 PBL库的注释必须标明该库的类别及其功能。 格式：库类别（10个汉字，不足用‘-’补齐）+功能。 如： 公用库公用函数 业务逻辑汇缴处理 用户界面归集查询分析b).PBL内对象注释 PBL内对象的注释应标明该对象所属的业务、作者及其功能。格式：所属业务（10个汉字，不足用‘-’补齐）+作者名（3个汉字，不足用‘-’补齐）+‘--’+功能描述 如： 公用函数惠兴海--以给定分隔符合并字符串 汇缴处理喻兵汇缴用户界面，处理正常汇缴业务2.3.3.2Script注释a).注释符号 ‘//’不许使用’/**/’作注释符。b).函数注释每个函数都应描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。格式：////Function: 函数名//Purpose: 用途//Scope: 作用范围//Args: 入口参数(列表) 类型 传值方式 含义//Returns: 返回值类型 （可确定值列表） 含义//c).非函数注释 注明该模块的作用 格式： // //功能 //d).程序行间注释 在程序行的每一个处理单元前作注释。 格式： //注释e).注释举例////Function: F_FindObject//Purpose: 按照控件名在可视化主对象中查找主对象内的可视化控件。//Scope: Public//Arguments: ls_name String Value 将要查找的控件名// lpbo_object PowerObject Value 可视化主对象// lpbo_find PowerObject Ref 存放并返回查找到的控件,返回NULL则表// 示可 视化主对象内无控件或可视化主对象不能包含// 控件//Returns: Boolean True 表示找到该控件// False 表示未找到该控件//Integer li_loop,li_totalWindow lw_objectUserObject luo_objectString ls_control_nameObject lo_typeli_loop=1//取得lpbo_object的类型lo_type=lpbo_object.TypeOf()//根据lpbo_object的类型分别处理ChooseCaselo_type CaseWindow!//Window类型 lw_object=lpbo_object li_total=UpperBound(lw_object.control[]) Ifli_total<1Then SetNull(lpbo_find) ReturnFalse EndIf//查找 DoWhileli_loop<=li_total ls_control_name=lw_object.control[li_loop].ClassName() Ifls_control_name=ls_nameThen lpbo_find=lw_object.control[li_loop] ReturnTrue EndIf li_loop++ Loop SetNull(lpbo_find) ReturnFalse CaseUserObject!//UserObject类型 luo_object=lpbo_object IfNOTluo_object.objecttype=CustomVisual!Then SetNull(lpbo_find) ReturnFalse EndIf//可视UserObject类型 li_total=UpperBound(luo_object.control[]) Ifli_total<1Then SetNull(lpbo_find) ReturnFalse EndIf//查找 DoWhileli_loop<=li_total ls_control_name=luo_object.control[li_loop].ClassName() Ifls_control_name=ls_nameThen lpbo_find=luo_object.control[li_loop] ReturnTrue EndIf li_loop++ Loop SetNull(lpbo_find) ReturnFalseEndChoose//非Window和UserObject类型SetNull(lpbo_find)ReturnFalse 2.3.3.3Script书写规范2.3.3.3.1大小写a).大写 以下项目必须用大写书写： 1).SQL关键字，如：INSERT、SELECT、USING等 2).逻辑运算符，如：NOT、AND、OR等b).小写 以下项目必须用小写书写： 1).各种对象名2).各种对象的属性 3).各种变量 4).数据表拥有者名称，如：dba 5).数据表名 6).字段名c).匈牙利书写法 以下项目必须用匈牙利书写法书写： 1).用于定义变量的对象类型，如CW_Process_Ancestor 2).枚举值，如：KeyF1!,Question!,WriteMode! 3).除逻辑运算符之外的所有PB关键字 4).函数名称（包括系统函数、用户函数、外部函数和存储过程）2.3.3.3.2局部变量声明的位置局部变量的声明必须写在该模块中所有可执行代码之前（游标定义除外）。2.3.3.3.3缩进按照程序处理的层次关系逐级缩进。缩进符：[Tab]键。不许用空格键缩进。2.3.3.3.4间隔1).在定义变量时应在声明类型和变量之间用[Tab]键分隔，使每一项声明的第一个变量尽可能的垂直对齐。2).在数学运算符、逻辑运算符的前后两端必须各以一个空格与其两边的部分分隔。2.3.3.3.5换行每一条语句占一行或多行，不许在一行中书写一条以上的语句（即在一行上不能有用’;’分开的两条或两条以上的语句）。2.3.3.3.6分节根据程序处理中不同的阶段用空行对各个阶段分节（至少一个空行，最多可有两个连续的空行）。2.3.3.3.7SQL书写规范a).分行 每个SQL关键字或短语应占一行，关键字和其后的字段、变量、条件表达式等应以[Tab]键分隔，尽量使关键字后的字段、变量、条件表达式等的第一项垂直对齐。b).顺序 1).操作子句后的字段排列应与字段在数据库中的物理顺序一致 2).WHERE子句后的条件表达式的排列顺序应与FROM子句中的表的排列顺序相对应，条件表达式中的字段出现顺序应与字段在数据库中的物理顺序一致，但是若条件表达式中的字段存在索引，则条件表达式中的字段出现顺序应与字段在索引中的排列顺序一致3.软件系统结构设计3.1复审数据流、控制流复审需求分析阶段对软件的功能需求的描述（如系统的DFD图和IDEF0图）是否合理和精化。否则，应在本节进行进一步分解和精化。3.2软件体系结构3.2.1软件程序结构图3.2.2模块命名规则3.2.2.1功能编号定义：FXXYY00a).F 1位，代表功能（FUNCTION）；b).XX 2位，代表子系统编号；c).YY 2位，代表子系统下的一级模块编号；d).00 2位，代表二级及二级以下模块的流水编号；3.2.2.2功能命名定义：操作+‘_’+操作对象名称如Edit_Persona).操作 代表实施某一动作，如Edit、Adjust、Query等；b).操作对象名称 代表操作对象，如Person、Rate、Render等；该位可选；3.2.3模块描述3.2.3.1学校微网站3.2.3.1.1学校简介：对学校简介和机构进行管理名称文件、通知、规范、规定的网上收发标识F0101子系统名称办公管理系统名称系统（OA）接口说明输入文件、通知、规范、规定等的信息输出文件、通知、规范、规定等的信息功能说明通过网上收发文件、通知、规范、规定等。运行环境说明用LotesNotes实现。调用关系说明调用模块办公管理被调用模块文件、通知、规范、规定的接收、发送3.2.3.1.2信息公告：学校通知、公告、新闻的展示名称电子邮件的收发标识F0102子系统名称办公管理系统名称系统（OA）接口说明输入邮件收发信息输出邮件收发信息功能说明通过Notes实现电子邮件的收发功能。运行环境说明用LotesNotes实现。调用关系说明调用模块办公管理被调用模块电子邮件的接收、发送3.2.3.2用户管理3.2.3.2.1组织机构管理：将所有组织机构统一管理起来，实现学校、班级机构的属性管理，能够通过统一的界面方便的创建、修改、冻结（毕业班级）组织机构名称文件资料分类登记标识F0201子系统名称文件资料库管理系统名称系统（OA）接口说明输入文件资料基本信息输出文件资料基本信息功能说明登记文件资料的基本信息，其中级别可分为：国家、省、市、本公司、各部门和分公司、其他，类别可分为：行政制度、质量、安全、其他等。运行环境说明用LotesNotes实现。调用关系说明调用模块办公管理被调用模块3.2.3.2.2文件资料分类查询名称文件资料分类查询标识F0202子系统名称文件资料库管理系统名称系统（OA）接口说明输入查询条件输出文件资料库信息功能说明通过查询条件，检索各种文件资料信息，并提供浏览功能。运行环境说明用LotesNotes实现。调用关系说明调用模块办公管理被调用模块3.2.3.2.3用户管理名称文件资料维护标识F0203子系统名称文件资料库管理系统名称系统（OA）接口说明输入文件资料修改信息输出文件资料库信息功能说明通过查询，检索文件资料信息，进行修改维护。运行环境说明用LotesNotes实现。调用关系说明调用模块办公管理被调用模块3.2.3.2.3.1家长注册：家长通过扫描二维码或到APP应用商店搜索下载安装和注册，填写相关用户信息：用户名、密码、关联子女和所在的班级，提交审核后生效，家长注册由子女所在班级班主任审核3.2.3.2.3.2老师注册：老师账户由管理员进行分配，设定用户名、密码、关联班级3.2.3.2.3.3领导注册：由管理员设定用户名、密码3.2.3.2.4权限管理：建设统一的权限管理系统体系，采用RBAC模型，将资源及权限信息统一存储，能够进行分级授权3.2.3.3信息发布3.2.3.3.1发布通知、公告、新闻等信息。可对这些信息进行管理，包括：发布、修改、删除、置顶名称技术资料分类登记标识F0301子系统名称技术资料库管理系统名称系统（OA）接口说明输入技术资料基本信息输出技术资料基本信息功能说明登记技术资料的基本信息，其中级别可分为：国家、省、市、本公司、各部门和分公司、其他，类别可分为：行政制度、质量、安全、其他等。运行环境说明用LotesNotes实现。调用关系说明调用模块办公管理被调用模块3.2.3.4交流互动3.2.3.4.1提供一对一、一对多、多对多交流沟通方式，用户可以进行即时沟通和留言，不只能通过文字进行沟通，还需要能发送语音进行沟通名称业务信息管理标识F0401子系统名称经营管理系统名称系统接口说明输入业务基本信息输出业务基本信息功能说明登记招标基本信息，即业务基本信息。通过万能查询，可以检索各种业务信息记录，及时了解招标信息。对已登记的招标信息进行维护。运行环境说明查询可独立成为一个模块调用关系说明调用模块经营管理被调用模块业务信息录入、查询、维护。3.2.3.5课后作业3.2.3.5.1任课老师具有布置课后作业的功能，学生和家长都可以看到自己老师布置的作业名称项目工程概况标识F050101子系统名称项目管理——项目立项系统名称系统接口说明输入项目工程概况输出项目工程信息功能说明登记项目工程概况，即项目基本信息的录入。运行环境说明调用关系说明调用模块项目管理——项目立项被调用模块名称项目工程部概况标识F050102子系统名称项目管理——项目立项系统名称系统接口说明输入项目工程部概况输出项目工程部成员信息功能说明登记项目工程部成员的基本信息，所担任的角色等信息。运行环境说明调用关系说明调用模块项目管理——项目立项被调用模块3.2.3.6学生活动3.2.3.6.1老师可以将学生活动信息（文字描述和活动照片）发布到APP上，家长可以随时浏览名称材料价格管理标识F0601子系统名称材供管理系统名称系统接口说明输入材料价格基本信息输出材料价格基本信息功能说明登记材料价格信息，并对价格信息进行随时维护。提供材料价格的综合查询功能（对所有用户都有此查询操作权限）。其中价格综合查询时，提供相应材料的加权平均价。运行环境说明调用关系说明调用模块材供管理被调用模块材料价格录入、查询、维护3.2.3.8学生成绩3.2.3.8.1将学生成绩信息集成到该平台，教务系统（学籍系统）提供学号、学生名称、科目、成绩信息，家长可随时查看学生成绩名称在职人员信息登记标识F080101子系统名称人事管理——人员信息登记系统名称系统接口说明输入在职人员信息输出在职人员信息功能说明登记在职人员基本信息运行环境说明调用关系说明调用模块人事管理——人员信息登记被调用模块名称离退休人员信息登记标识F080102子系统名称人事管理——人员信息登记系统名称系统接口说明输入离退休人员基本信息输出离退休人员基本信息功能说明登记离退休人员基本信息运行环境说明调用关系说明调用模块人事管理——人员信息登记被调用模块名称员工工资登记标识F080103子系统名称人事管理——人员信息登记系统名称系统接口说明输入员工工资信息输出员工工资信息功能说明登记公司员工工资基本信息。接收分公司上报的员工的工资数据。运行环境说明各分公司具有独立模块，上报员工的工资数据。调用关系说明调用模块人事管理——人员信息登记被调用模块3.2.3.9学生奖罚3.2.3.9.1将学生奖罚信息集成到该平台，学工系统（学生管理）提供学号、学生姓名、奖罚信息，家长可及时关注子女的奖罚情况名称业务信息管理标识F0901子系统名称设计院信息管理系统名称系统接口说明输入设计院业务信息输出设计院业务信息功能说明记录设计院的业务信息基本内容。提供万能查询，检索设计院业务信息。对业务信息进行维护。运行环境说明调用关系说明调用模块设计院信息管理被调用模块业务信息的录入、查询、维护。3.2.3.10学生评语3.2.3.10.1老师可对每位学生进行评价，填室评语，家长随时查看学生评语信息名称财务报表录入标识F1001子系统名称财务报表管理系统名称系统接口说明输入财务报表信息输出财务报表信息功能说明记录公司各部门的财务报表数据。运行环境说明调用关系说明调用模块财务报表管理被调用模块3.3功能需求追溯模块1模块2模块3模块4模块5模块6模块7模块8模块9模块10模块11模块12功能需求1——办公管理√功能需求2——文件资料库管理√功能需求3——技术资料库理√功能需求4——经营管理√功能需求5——项目管理√功能需求6——材供管理√功能需求7——设备管理√功能需求8——人事管理√功能需求9——设计院管理√功能需求10——财务报表管理√功能需求11——房地产管理√功能需求12——系统管理√4.复用策略1)利用已有的在LOTUSNOTES开发的