流程产品开发规范-Remedy

Remedy流程产品 开发规范(初稿)XXXXX软件股份有限公司2016年9月EOMS三期工程开发规范 文档说明本文档所涉及到的文字、图表等，仅限于北京XXXXX软件有限公司内部使用，未经北京XXXXX软件有限公司书面许可，请勿扩散到第三方。文档属性属性内容客户名称：项目名称：文档主题：开发规范设计文档编号：文档版本：1. 0版本日期：2006年9月15日文档状态：初稿作者：XXXXX文档变更版本修订日期修订人描述1.02006-10-16XXXXX创建2.02008-11-20XXXXX修订文档送呈单位姓名目的目 录1前言41.1编写目的41.2适用范围41.3文档交付42Remedy开发规范52.1命名规范52.2排版规范112.3开发规范111 前言1.1 编写目的本文是为了表述 Remedy的开发规范和指南，用来作为软件开发项目开发规范部分的基础。本文档所有内容由开发组指定专门人员更新并监督执行。1.2 适用范围本文件只在本项目范围内有效，适用于所有参与产品开发和集成项目的开发人员、管理人员等。1.3 文档交付表格1. 文档交付表角色姓名单位拟制校验审核批准2 Remedy开发规范2.1 命名规范2.1.1 总体要求1、 指各对象DateBase属性中的Name的命名规范。2、 所有对象名称不允许出现空格，应以下划线连接各部分命名名称；3、 命名不允许出现中文字符，尤其是Remedy 系统自带Field的名称，应按照本规范修改为英文名称，各Field命名详见2.1.3.1；4、 最好使用常见英文单词命名对象名称，单词首字母大写，其他字母则小写；5、 对象名称字符长度不应超过30个字符；2.1.2 FORM命名规范2.1.2.1 工单类FORM定义：指系统一般用户进行业务操作的工单，如流程类工单。采用“:_工单含义英文全名”的方式。其中“XXXXXProcess或WF”不变，“FORM含义英文全名”每个单词的首字母大写，如：XXXXXProcess:App_Base。2.1.2.2 配置类FORM定义：指系统管理员进行系统配置的界面，如增删改Menu的界面。采用“:Config_FORM含义英文全名”的方式。其中“XXXXXProcess”不变，“FORM含义英文全名”每个单词的首字母大写，如：XXXXXProcess:Config_TaskItem。2.1.2.3 资源类录入FORM定义：指各种信息资源的录入界面FORM，此类FORM一般为Display Only型。采用“:Source_FORM含义英文全名”的方式。其中“XXXXXProcess” 不变，“FORM含义英文全名”每个单词的首字母大写，如：XXXXXProcess:Source_GSM。2.1.2.4 资源类数据FORM定义：指各种信息资源的后台数据FORM。采用“:Source_DB_FORM含义英文全名”的方式。其中“XXXXXProcess” 不变，“FORM含义英文全名”每个单词的首字母大写，如：XXXXXProcess:Source_DB_GSM。2.1.2.5 临时类FORM定义：指系统为完成某项功能而在后台建立的数据库表单，此类Form一般只有系统开发人员才能够访问，如。采用“:Temp_FORM含义英文全名”的方式。其中“XXXXXProcess” 不变，“FORM含义英文全名”每个单词的首字母大写，如：XXXXXProcess:Temp_Notice。2.1.3 Field命名规范2.1.3.1 AR系统自带Field的命名方法全部重命名为英文名称，具体名称如下：1、 Request ID：AR_RequestID2、 提交人：AR_Submitter3、 创建日期：AR_CreateDate4、 指定给：AR_AssignedTo5、 上次修改者：AR_LastModifiedBy6、 修改日期：AR_ModifiedDate7、 状态：AR_Status8、 简要描述：AR_ShortDescription2.1.3.2 常用Field定义：此类Field指Form中常见类型Field，对应工单中一般指主要业务字段。包含Date Field、Date/Time Field、Integer Field、RealNum Field、Decimal Number Field、Drop-Down List Field、Radio Button Field、Check Box Field、Time Field等。原则上不强行要求此类Field的命名，应遵照总体要求；补充：上述所有包含的对象参照下面的命名方式；2.1.3.3 Text Field采用“txt_含义英文全名”的方式，含义名每个单词首字母大写。如：txt_Title。2.1.3.4 Table Field采用“tbl_含义简英文名”的方式，含义名每个单词首字母大写。如：tbl_Group。2.1.3.5 Column Field采用“col_含义简英文名”的方式，含义名每个单词首字母大写。如：col_GroupId。2.1.3.6 Page Holder Field采用“pag_含义简英文名”的方式，含义名每个单词首字母大写。如：pag_Basic。2.1.3.7 Page Field采用“p_含义简英文名”的方式，含义名每个单词首字母大写。如：p_Assignee。2.1.3.8 变量字段2.1.3.8.1 展现Field定义：指Field的Database属性中Entry Mode为Display Only类型的字段及其他临时字段，在工单页面上显示的。补充2.1.3.8.2 不展现Field定义：指Field的Database属性中Entry Mode为Display Only类型的字段及其他临时字段，不显示。采用“_字段类型代码_含义英文全名”的方式，含义名每个单词首字母大写。如：_chr_UserFullName。字段类型代码列表（和其他语言一致，确定位数）：表格2. 字段类型代码列表序号字段类型类型代码1.字符型s2.数字i3.时间time2.1.4 Active Link命名规范注：所有Active Link在一个AR服务上应为全局唯一命名，否则AR系统会报错。原则上Active Link命名方式为：采用“FORM名称_动作_Guide _序号”的方式。以下将分别叙述典型动作的命名方式。2.1.4.1 Form加载时定义：指Form以“CREATE”或“QUERY”方式打开，Form在window open、window load、display时进行的动作；采用“FORM名称_Init_Guide _序号”的方式。如：XXXXXProcess:Task_Init_01，或XXXXXPROCESS_Task_Init_Guide_01。2.1.4.2 点击Button时定义：指Form中的按钮点击时执行的动作；采用“FORM名称_Btn_按钮名称_含义_序号”的方式。如：XXXXXProcess:Task_Btn_Edit_EnableFields_01。2.1.5 Filter命名规范注：所有Filter在一个AR服务上应为全局唯一命名，否则AR系统会报错。原则上Filter命名方式为：“FORM名称_Btn_动作_含义_Guide _序号”如：XXXXXProcess:Task_Btn_Finish_01，XXXXXProcess:Task_Btn_Finish_Guide_01。2.1.6 Active Link Guide命名规范注：所有Active Link Guide在一个AR服务上应为全局唯一命名，同时不能和同一服务上的Filter Guide重名，否则AR系统会报错。原则上Active Link Guide命名方式为：“FORM名称_Guide_Btn_动作_含义_序号”如：XXXXXProcess:Task_Guide_Btn_Finish_EnableFields_01。2.1.7 Filter Guide命名规范注：所有Filter Guide在一个AR服务上应为全局唯一命名，同时不能和同一服务上的Active Link Guide重名，否则AR系统会报错。原则上Filter Guide命名方式为：“FORM名称_Guide_Btn_动作_序号”如：XXXXXProcess:Task_Guide_Btn_Finish_01。2.1.8 Menu命名规范2.1.8.1 某Form专用时“FORM名称_业务英文简称”如：XXXXXProcess:Task_Item。2.1.9 Escalation命名规范原则上Escalation命名方式为：“FORM名称_动作_序号”如：XXXXXProcess:Category_ClearLastNo。2.2 排版规范2.2.1 应用系统自动填写的对象1、 此类对象指工单流水号、建单人、建单时间、建单部门、建单单位、工单状态等应用系统自动填写的对象；2、 此类对象一般放置在Form的最上方，建议四个字段一排；2.2.2 一般对象1、 此类对象指工单上的业务字段，如主题、专业等；2、 此类对象一般放置在Form的中部，为工单的主要内容，建议将四个字段排成一排，必要时应使用Page Hold将不同业务及不同作用的对象分别放置；3、 字段纵向间距不小于21象素，不大于35象素（指对象位置的Y坐标值）；并要求使用排版工具将字段横向、纵向及大小排列整齐；（美工）2.2.3 AR系统自带及变量型Field的排版方法采用Page Hold的方式将AR系统自带及自建变量型对象分别放置的方式，具体操作方式如下：在Page Hold建立多个Page，将AR系统自带的Field放置在以“AR”命名的Page中；自建Field放置其他不同的Page中，Page的命名应遵守命名规范的总体要求；2.3 开发规范2.3.1 系统自带的Field1、 C2字段设置默认值为关键字“$USER$”；2、 绝不允许用系统自带的Field进行程序上的逻辑判断（C1字段除外）；2.3.2 Field ID的分配Field ID应由项目经理或技术总监统一分配，ID为56*的为系统核心字段（Base表），核心工单或配置表使用，任何人使用其他人ID需经过对方和项目经理同意；表格3. Field ID分配表序号姓名ID范围1.2.3.4.5.6.7.2.3.3 Help Text的使用1、 对象的Help Text属性中注明的内容包括：1) 创建者；2) 创建时间；3) 作用描述；4) 修改者；5) 修改时间：6) 修改目的；7) 修改描述；2、 重要的对象必须在Help Text中详细注明。重要对象指：1) 通用任务工单中所有自定义变量型Field；2) 通用任务工单的所有Active Link、Filter及Guide；3) 自建工单中有重要逻辑判断的Field；4) 自建工单重要、特殊逻辑的Active Link、Filter及Guide；3、 按命名规范命名后区别不明显的对象，应在该对象的Help Text里给予说明；2.3.4 Active Link的执行顺序定义：指相同动下作执行的一系列Active Link。执行顺序应以5或5的倍数进行递增。2.3.5 Filter的执行顺序定义：指相同动作下作执行的一系列Active Link。执行顺序应以5或5的倍数进行递增。2.3.6 使用个人帐号登录开发开发人员应使用每个人自己的帐号登录进行程序的开发。每个人的帐号由项目经理分配。2.3.7 Direct SQLDirect SQL命令需写在Active Link、Filter中的Set命令，使用的Select语句中，不允许出现Select *的写法；2.3.8 Table FieldTable Field原则上不应选中