流程产品开发规范RemedyWord文档下载推荐.docx

流程产品开发规范RemedyWord文档下载推荐.docx

《流程产品开发规范RemedyWord文档下载推荐.docx》由会员分享，可在线阅读，更多相关《流程产品开发规范RemedyWord文档下载推荐.docx（9页珍藏版）》请在冰豆网上搜索。

版本

修订日期

修订人

描述

1.0

2006-10-16

创建

2.0

2008-11-20

修订

文档送呈

单位

姓名

目的

前言

编写目的

本文是为了表述Remedy的开发规范和指南，用来作为软件开发项目开发规范部分的基础。

本文档所有内容由开发组指定专门人员更新并监督执行。

适用范围

本文件只在本项目范围内有效，适用于所有参与产品开发和集成项目的开发人员、管理人员等。

文档交付

表格1.文档交付表

角色

拟制

校验

审核

批准

1Remedy开发规范

1.1命名规范

1.1.1总体要求

1、指各对象DateBase属性中的Name的命名规范。

2、所有对象名称不允许出现空格，应以下划线连接各部分命名名称；

3、命名不允许出现中文字符，尤其是Remedy系统自带Field的名称，应按照本规范修改为英文名称，各Field命名详见2.1.3.1；

4、最好使用常见英文单词命名对象名称，单词首字母大写，其他字母则小写；

5、对象名称字符长度不应超过30个字符；

1.1.2FORM命名规范

1.1.2.1工单类FORM

定义：

指系统一般用户进行业务操作的工单，如流程类工单。

采用“<

产品名称>

:

<

项目名称>

_工单含义英文全名”的方式。

其中“XXXXXProcess或WF”不变，“FORM含义英文全名”每个单词的首字母大写，如：

XXXXXProcess:

App_Base。

1.1.2.2配置类FORM

指系统管理员进行系统配置的界面，如增删改Menu的界面。

Config_<

_FORM含义英文全名”的方式。

其中“XXXXXProcess”不变，“FORM含义英文全名”每个单词的首字母大写，如：

Config_TaskItem。

1.1.2.3资源类录入FORM

指各种信息资源的录入界面FORM，此类FORM一般为DisplayOnly型。

Source_FORM含义英文全名”的方式。

其中“XXXXXProcess”不变，“FORM含义英文全名”每个单词的首字母大写，如：

Source_GSM。

1.1.2.4资源类数据FORM

指各种信息资源的后台数据FORM。

Source_DB_FORM含义英文全名”的方式。

Source_DB_GSM。

1.1.2.5临时类FORM

指系统为完成某项功能而在后台建立的数据库表单，此类Form一般只有系统开发人员才能够访问，如。

Temp_FORM含义英文全名”的方式。

Temp_Notice。

1.1.3Field命名规范

1.1.3.1AR系统自带Field的命名方法

全部重命名为英文名称，具体名称如下：

1、RequestID：

AR_RequestID

2、提交人：

AR_Submitter

3、创建日期：

AR_CreateDate

4、指定给：

AR_AssignedTo

5、上次修改者：

AR_LastModifiedBy

6、修改日期：

AR_ModifiedDate

7、状态：

AR_Status

8、简要描述：

AR_ShortDescription

1.1.3.2常用Field

此类Field指Form中常见类型Field，对应工单中一般指主要业务字段。

包含DateField、Date/TimeField、IntegerField、RealNumField、DecimalNumberField、Drop-DownListField、RadioButtonField、CheckBoxField、TimeField等。

原则上不强行要求此类Field的命名，应遵照总体要求；

补充：

上述所有包含的对象参照下面的命名方式；

1.1.3.3TextField

采用“txt_含义英文全名”的方式，含义名每个单词首字母大写。

如：

txt_Title。

1.1.3.4TableField

采用“tbl_含义简英文名”的方式，含义名每个单词首字母大写。

tbl_Group。

1.1.3.5ColumnField

采用“col_含义简英文名”的方式，含义名每个单词首字母大写。

col_GroupId。

1.1.3.6PageHolderField

采用“pag_含义简英文名”的方式，含义名每个单词首字母大写。

pag_Basic。

1.1.3.7PageField

采用“p_含义简英文名”的方式，含义名每个单词首字母大写。

p_Assignee。

1.1.3.8变量字段

1.1.3.8.1展现Field

指Field的Database属性中EntryMode为DisplayOnly类型的字段及其他临时字段，在工单页面上显示的。

补充

1.1.3.8.2不展现Field

指Field的Database属性中EntryMode为DisplayOnly类型的字段及其他临时字段，不显示。

采用“_字段类型代码_含义英文全名”的方式，含义名每个单词首字母大写。

_chr_UserFullName。

字段类型代码列表（和其他语言一致，确定位数）：

表格2.字段类型代码列表

序号

字段类型

类型代码

1.

字符型

s

2.

数字

i

3.

时间

time

1.1.4ActiveLink命名规范

注：

所有ActiveLink在一个AR服务上应为全局唯一命名，否则AR系统会报错。

原则上ActiveLink命名方式为：

采用“FORM名称_动作[_Guide][_序号]”的方式。

以下将分别叙述典型动作的命名方式。

1.1.4.1Form加载时

指Form以“CREATE”或“QUERY”方式打开，Form在windowopen、windowload、display时进行的动作；

采用“FORM名称_Init[_Guide][_序号]”的方式。

Task_Init_01，或XXXXXPROCESS_Task_Init_Guide_01。

1.1.4.2点击Button时

指Form中的按钮点击时执行的动作；

采用“FORM名称_Btn_按钮名称_含义[_序号]”的方式。

Task_Btn_Edit_EnableFields_01。

1.1.5Filter命名规范

所有Filter在一个AR服务上应为全局唯一命名，否则AR系统会报错。

原则上Filter命名方式为：

“FORM名称_[Btn]_动作_含义[_Guide][_序号]”

Task_Btn_Finish_01，XXXXXProcess:

Task_Btn_Finish_Guide_01。

1.1.6ActiveLinkGuide命名规范

所有ActiveLinkGuide在一个AR服务上应为全局唯一命名，同时不能和同一服务上的FilterGuide重名，否则AR系统会报错。

原则上ActiveLinkGuide命名方式为：

“FORM名称_Guide_[Btn]_动作_含义[_序号]”

Task_Guide_Btn_Finish_EnableFields_01。

1.1.7FilterGuide命名规范

所有FilterGuide在一个AR服务上应为全局唯一命名，同时不能和同一服务上的ActiveLinkGuide重名，否则AR系统会报错。

原则上FilterGuide命名方式为：

“FORM名称_Guide_[Btn]_动作[_序号]”

Task_Guide_Btn_Finish_01。

1.1.8Menu命名规范

1.1.8.1某Form专用时

“FORM名称_业务英文简称”

Task_Item。

1.1.9Escalation命名规范

原则上Escalation命名方式为：

“FORM名称_动作[_序号]”

Category_ClearLastNo。

1.2排版规范

1.2.1应用系统自动填写的对象

1、此类对象指工单流水号、建单人、建单时间、建单部门、建单单位、工单状态等应用系统自动填写的对象；

2、此类对象一般放置在Form的最上方，建议四个字段一排；

1.2.2一般对象

1、此类对象指工单上的业务字段，如主题、专业等；

2、此类对象一般放置在Form的中部，为工单的主要内容，建议将四个字段排成一排，必要时应使用PageHold将不同业务及不同作用的对象分别放置；

3、字段纵向间距不小于21象素，不大于35象素（指对象位置的Y坐标值）；

并要求使用排版工具将字段横向、纵向及大小排列整齐；

（美工）

1.2.3AR系统自带及变量型Field的排版方法

采用PageHold的方式将AR系统自带及自建变量型对象分别放置的方式，具体操作方式如下：

在PageHold建立多个Page，将AR系统自带的Field放置在以“AR”命名的Page中；

自建Field放置其他不同的Page中，Page的命名应遵守命名规范的总体要求；

1.3开发规范

1.3.1系统自带的Field

1、C2字段设置默认值为关键字“$USER$”；

2、绝不允许用系统自带的Field进行程序上的逻辑判断（C1字段除外）；

1.3.2FieldID的分配

FieldID应由项目经理或技术总监统一分配，ID为56*的为系统核心字段（Base表），核心工单或配置表使用，任何人使用其他人ID需经过对方和项目经理同意；

表格3.FieldID分配表

ID范围

4.

5.

6.

7.

1.3.3HelpText的使用

1、对象的HelpText属性中注明的内容包括：

1）创建者；

2）创建时间；

3）作用描述；

4）修改者；

5）修改时间：

6）修改目的；

7）修改描述；

2、重要的对象必须在HelpText中详细注明。

重要对象指：

1）通用任务工单中所有自定义变量型Field；

2）通用任务工单的所有ActiveLink、Filter及Guide；

3）自建工单中有重要逻辑判断的Field；

4）自建工单重要、特殊逻辑的ActiveLink、Filter及Guide；

3、按命名规范命名后区别不明显的对象，应在该对象的HelpText里给予说明；

1.3.4ActiveLink的执行顺序

指相同动下作执行的一系列ActiveLink。

执行顺序应以5或5的倍数进行递增。

1.3.5Filter的执行顺序

指相同动作下作执行的一系列ActiveLink。

1.3.6使用个人帐号登录开发

开发人员应使用每个人自己的帐号登录进行程序的开发。

每个人的帐号由项目经理分配。

1.3.7DirectSQL

DirectSQL命令需写在ActiveLink、Filter中的Set命令，使用的Select语句中，不允许出现Select*的写法；

1.3.8TableField

TableField原则上不应选中“RefreshOnEntryChange”；

1.3.9定期删除数据

数据量增长较快的临时FORM，如AXXXXXPROCESS:

Notice_temp，要求定期删除数据，可通过FORMProperties中的Archive或Escalation实现。

2Remedy流程产品字段ID分配

流程基本Form（XXXXXProcess:

App_Base或WF:

App_Base_Bak）中的字段ID范围为：

（700000000到799999999）

3Remedy流程项目字段ID分配

流程Form中的字段ID范围为：

（大于800000000）