《金富瑞UCML协同办公系统开发标准.doc》由会员分享，可在线阅读，更多相关《金富瑞UCML协同办公系统开发标准.doc（14页珍藏版）》请在三一办公上搜索。
1、UCML协同办公系统设计开发标准金富瑞（北京）科技有限公司Goldframe Technologies Co., Ltd.目 录第一章 UCML协同办公系统设计开发标准3一、 设计标准31 设计文档3二、 开发标准31 数据库设计标准311 表的命名312 视图的命名313 存储过程命名314 字段命名32 业务开发规范421 业务组件的使用422 视图组件的使用423 业务单元的使用53 按钮处理规范531 标准按钮名称及说明532 在列表中的按钮633 在编辑中的按钮74 程序处理规范841 对象标注规范842 程序处理说明843 在程序中OPEN一个新窗口的说明8第二章 UCML协同办公
2、系统文档规范9第一章 UCML协同办公系统设计开发标准一、 设计标准1 设计者职责1) 公共功能需求分析与抽象公共的业务逻辑模型及生产线设计，提供概要设计书2) 业务模型开发初期业务模型准备：项目中可能利用到的公共模型的准备与设计，功能的整理，提取，新的设计的概要设计页面模版的准备：统一的页面模版与风格的设计，页面模版整理，提取，新模版的设计业务需求分析：需求说明书3) 业务模型开发前期框架搭建，在平台上进行数据库结构设计BC详细设计VC的概略设计：页面框架，页面展现方式选择,在页面利用平台工具简单生成，或者在块上引用图片，或者文字描述说明BPO的概略设计：将基本的BC与VC挂接，开发中的主要
3、关键处理方法，属性，函数等定义，说明（暂时只定义服务层部分） 利用平台功能输出概要设计书4) 业务模型开发中期与模块开发者业务的沟通，设计的沟通日报,周会,小组会议对开发业务模块质量跟踪日报业务模块设计评审：界面，详细框架设计（只包含函数名，不具体实现）输出WORD5) 业务模型开发后期帮助说明书需求变更说明书组织测试（功能正确性，流程正确性，压力测试等）根据需求变更说明书项目业务模块的迭代开发最终评审6) 项目开发完毕项目版本提交组织培训，实施2 设计文档3 总体处理菜单调整-根据系统管理员、业务管理配置人员、个人配置三种角色修改菜单结构总体配置参数处理-系统中的所有业务配置参数采用统一模式
4、处理，参照【考勤管理】，配置项编码根据公司统一规定命名配置项分类编码处理-由统一的配置项分类代码表规范，代码表名称为【UCML_SysConfigType】,系统的配置项（在所有系统中公用的配置参数）代码为【SYS】产品名称命名标准如下：序号产品代码产品名称1OA办公自动化2HR人力资源管理3CRM客户关系管理4业务编码标准：序号产品代码业务代码业务名称1OAPM项目管理2OAAM考勤管理3OAHM帮助系统4OA如OA中的项目管理相关的所有表都以“OAPM_”开头，这两个字母要大写；【代表该项功能的英文组合名称】：尽量用英文单词、单词简写或组合，取每个单词第一个字母大写。业务模块分目录、业务层
5、命名空间二、 开发标准1 程序员职责1) 公共功能设计根据概要设计说明以及需求变更设计，设计与修改公共功能模块功能说明书2) 业务模块开发业务模型准备：根据新的通用业务的概要设计说明以及需求变更设计，设计业务模块业务需求理解，分析：根据项目需求说明书，理解业务，提供变更建议业务模块设计：根据概要设计说明，理解模块设计思想，相关技术的整理与学习，提供设计变更建议对模块的BC详细设计（微调）VC详细设计BPO界面展现设计界面处理逻辑详细设计（定义的属性、方法、事件名称及相关处理说明，不包含处理代码），经公司领导，设计者评审认可后，最后编写BPO中各类编程点的详细逻辑代码单元自测保证制作的业务模块，
6、以工程模式生成时，编辑通过，执行无误，消除模块内出现所有警告，错误等信息交叉测试模块操作帮助文档2 数据库设计标准21 命名标准各类表，视图，对象，BC，VC，BPO命名直接参考代码表【UCML_SysConfigType】中定义获取下文中【XX】代表产品简称【YY】代表业务模块分类22 表的命名【XX】【YY_】+代表该项功能的英文组合名称23 视图的命名【表名】+【_】+【含义说明】+【View】相关表组合：如果是一个表的视图，就直接用该表名，如果是多个表用表名进行组合；含义说明：起到辨识区分作用。程序中不建议使用视图操作，在实体对象中构件对应SQL语句的方法实现24 存储过程命名【Pro
7、c_】+【表名】+【_】+【含义说明】含义说明：起到辨识区分作用。25 字段命名代表中文含义的英文字母、简写或组合不要用SQL Server，Oracle的关键字外键字段: 【外键关联表名】+ 【_FK】引用代码表字段: 【代码表识别码】+ 【_Cd】3 业务开发规范31 业务组件的使用命名规范：【BC_】+【表名】+【含义说明】含义说明：如果该业务组件专用于列表格式，含义说明要包含“list”，如果该业务组件专用于编辑格式，含义说明要包含“edt”；使用说明：如果数据表中的字段个数不超过10个，用于列表中的业务组件的字段个数多少不受限制，但如果数据表中的字段超过10个，用于列表格式的业务组件
8、中的字段个数一般等于显示在前端的字段个数；用于Join视图组件、Treegrid视图组件的业务组件也参照此标准处理。32 视图组件的使用命名规范：【VC_】+【表名】+【含义说明】+【视图组件类型标识】中文名命名规范:1.提供选择的公共组件：【选择方式】+【实体对象中文简写】+ 【含义说明】如 群组_部门岗位人员_树；单选_部门人员_树；2.业务个性的视图组件:【表名】+ 【含义说明】+【视图组件类型标识】含义说明：视图组件的作用说明，可以为空；视图组件类型标识：区分视图组件类型的标识Grid模式gd,grid,listEdit模式edit,edtTree模式tr,tree参与者视图join,
9、jn填报报表Rep统计报表TJRepOffice控件DocHTML控件Html门户中的视图组件Potal使用说明：列表格式、Join视图组件、Treegrid视图组件的列要跟显示的一致，而且应充满窗口宽度；如果一个页面只有一个列表型视图组件，高度要充满窗口高度，读取的记录数设为20条编辑界面中，值域为空情况下，在字段名前加大红色”*”提示。33 业务单元的使用命名规范：【BPO_】+【表名】+【含义说明】+【操作类型标识】中文名命名规范:1.提供选择的业务组件：【选择方式】+【实体对象中文简写】+ 【含义说明】如 群组_部门岗位人员_树；单选_部门人员_树；2.业务个性的业务组件:【表名】+
10、【含义说明】+【视图组件类型标识】含义说明：业务单元的作用说明，可以为空；操作类型标识：区分该业务对象的功能处理标识，是用于增加、编辑、查看记录，报表统计、流程处理功能列表gd,grid,list新增Ins编辑edit,edt查看View报表Rep其它对象命名规范：服务端函数：【Fns_】+相关说明前段函数：【fn_】+相关说明服务端属性：【Ps_】+相关说明前端属性：【P_】+相关说明前段自定义事件：【Usr_】+相关说明使用说明：列表格式、Join视图组件、Tree。4 按钮处理规范41 标准按钮名称及说明在业务处理中，当使用遇到如下的处理功能时，其显示的按钮名称要用如下的统一标识。新增弹
11、出一个独立的编辑窗口并增加一条新记录增加直接在当前窗口增加一条新记录编辑弹出一个独立的编辑窗口并在窗口中修改当前记录查看弹出一个独立的编辑窗口并在窗口中查看当前记录，不允许修改删除删除当前记录，删除前要提示“确实要删除当前记录吗？”，如果选择是，删除当前记录并直接调用BusinessSubmit()保存数据删除所选批量删除多条记录，第一列为checkbox选择框，列名定义为“IsChoice”，具有“全选”，“反选”功能，点击删除所选前要提示“确实要删除当前所选的记录吗？”，如果选择是，删除当前所选记录并直接调用BusinessSubmit()保存数据批量删除按钮逻辑可调用代码快模板：（暂时未
12、定义）保存保存数据到数据库首页表示记录翻到第一页上页表示记录翻到上一页下页表示记录翻到下一页末页表示记录翻到最后一页查询调用自定义组合查询功能返回返回到前一个页面，如果是可编辑页面，返回前要判断是否有修改，如果有修改，弹出提示信息“业务数据有变化，是否确认要返回？”，是直接关闭本窗口并返回，返回后要刷新父窗口，否不做任何操作回到当前页面关闭关闭当前窗口，如果是可编辑页面，关闭前要判断是否有修改，如果有修改，弹出提示信息“业务数据有变化，是否确认要关闭？”，是直接关闭本窗口，否不做任何操作回到当前页面提交当业务启动流程时，如果是下级向上级申请，则用【提交】按钮，表示启动流程功能，在提交前要提示“
13、是否确认提交”，其它启动流程的处理也要有提示保存并返回保存记录并关闭本窗口，刷新父窗口页面保存并增加保存记录并增加一条新纪录42 在列表中的按钮 对列表上查看详细信息的统一处理无论该列表是用于编辑、浏览，在相关业务的主字段上（代表该业务的标识，如名称、标题等）都要有一个链接业务组件，弹出浏览该数据的详细信息窗口如果在该列表本身上直接增加、删除、编辑记录，则不需要做链接弹出页面 用于编辑业务的列表中的删除、编辑处理如果该列表是用于维护记录的，对该列表记录的编辑、删除按钮要放到对应的视图组件上，顺序是【编辑】【删除】【跟踪】 如果该列表用于直接增删改记录（用于记录行数比较少，字段个数较少的情况）列
14、表的按钮标准排列顺序为增加保存首页上页下页末页视图组件上的按钮为：【删除】 如果该列表只用于浏览查询列表的按钮标准排列顺序为：首页上页下页末页查询视图组件上的按钮为：【查看】 如果该列表是用于维护数据列表列表的按钮标准排列顺序为：新增首页上页下页末页视图组件上的按钮为：【编辑】【删除】 如果该列表是用于流程启动中维护数据列表列表的按钮标准排列顺序为：新增首页上页下页末页视图组件上的按钮为：【编辑】【删除】【跟踪】43 在编辑中的按钮 用于新增的编辑页面如果是在新增窗口可重复增加的：保存并返回保存并增加返回如果是在新增窗口只维护一条记录的：保存保存并返回返回 用户查看的页面关闭 用于启动流程的编
15、辑页面保存启动流程（提交或其它）返回 用于流程处理过程中的业务模块完成任务保存下一步同意退回流程跟踪关闭根据需要选择部分或增加按钮5 程序处理规范51 对象标注规范所有的数据对象、业务组件、视图组件、业务单元模块、方法、属性等要在系统提供的文字说明处有备注说明函数以52 程序处理说明在自己编写代码的头部分必须有这段代码的说明，代码修改后要修改相关文字代码内如果代码量较大（超过20行）在代码内相关部分要有文字说明53 在程序中OPEN一个新窗口的说明在IE中所有弹出的窗口要把IE的链接路径、菜单、按钮等去掉6 javascript编写61 引用在模块开发中，对js文件的引用，统一在BPO的“引用
16、的js文件”中定义62 函数编写模块中的使用的函数在BPO中编写统一命名:”mode” + 【含义说明】统一以mode开头【含义说明】：实际名称以英文缩写大写，或者英文字母首字母大写对函数名称，参数，返回等详细注释63 编写规范函数编写应考虑，该方法通用性，尽可能的抽象，提炼，最后报告主管填加到公共js文件中1. 界面事件处理initEv()：u 当界面控件需要绑定事件调用，定义函数initEv(),，在BPO的javascript初始化中调用u 模板标准操作全球生产线-业务逻辑模型模板-标准模型-界面初始化-界面事件处理initEv()2. 界面样式初始化initView()：u 主要针对界
17、面在布局，控件显示等样式方面详细调整的代码处理u 当该模块需要对界面元素的显示做特殊处理时候，定义函数initView(),在函数中根据实际业务需要编写代码，在BPO的javascript初始化中调用u 模板标准操作全球生产线-业务逻辑模型模板-标准模型-界面初始化-界面样式初始化initView ()3. 界面数据准备initData()：u 当该模块在打开时候前端需要数据处理，如BC循环处理，下拉框数据准备等u 定义函数initView(),在函数中根据实际业务需要编写代码，在BPO的javascript初始化中调用u 模板标准操作全球生产线-业务逻辑模型模板-标准模型-界面初始化-界面数据准备initData()第二章 UCML协同办公系统文档规范
