OracleEBS编码规范.doc

Oracle EBS开发编码规范天马信息技术管理部 （内部使用）文档变更记录版本号版本日期作者修改描述V1.02012-01-09 陈恩力初稿 V1.12012-2-14 陈恩力试行 V1.22012-2-22 陈恩力修改增加开发评分标准目 录1、引言51、编写目的52、适用范围53、文档规范52、数据库命名规范72.1表空间7系统表空间7用户表空间7表空间数据文件72.4 表相关8表名8列名8主键名8外键名8CHECK约束8UNIQUE约束8索引名9视图92.5 PL/SQL对象名9过程9函数9包92.6其他对象10角色名10序列名10同义词10数据库链103、SQL规范103.1 CREATE113.2 SELECT113.3 INSERT113.4 UPDATE113.5 DELETE115、PL/SQL开发规范115.1代码115.2对象名125.3参数125.4变量常量126、Operation System Files(操作系统档案)137、OAF开发规范13命名空间138、Applications Objects(系统对象)139、 Documentation （文件）1410、 开发评分标准151、引言1、编写目的 运用统一的数据库平台规范，对数据库及EBS整体命名以及编码风格进行标准化，便于管理开发以及维护人员进行阅读、交流与理解。 2、适用范围 本规范适用于所有以ORACLE EBS 为平台客制化开发的项目团队及维护团队。3、文档规范MMM 表示命名为在实际情况下MMM所表示的内容为模块缩写。并非MMM本身。AA + BB + CC表示名称为AABBCC。AA + BB + CC/DD表示名称为AABBCC或AABBDD。英文缩写对于英文单词较长的情况下，使用辅音缩写，缩写参照英文缩写规范，并尽量使用通用的缩写方式。如：European Community缩写为EC，European缩写为EUR。具体项目可根据实际情况拟定统一的英文缩写对照表。对于英文单词较短，如小于四位，可不进行缩写。系统模块英文缩写对照表示例：中文含义英文含义英文缩写总账General LedgerGL应付PayablesAP应收ReceivablesAR资产Fixed AssetFA现金Cash ManagementCE成本Cost ManagementCT库存InventoryIV采购PurchasingPO订单Order ManagementOM物料清单Bills of MaterialBM制造Work in ProcessWP添加有含义的英文缩写词典中文含义英文含义英文缩写来源补充规则PO Sourcing RuleSR批准的供应商列表Approved Suppliers ListASL物料交易批次Inventory Transaction LotINVTXNLOT库存周转天Quantity days of inventoryINVQTYDATE库龄Onhand AgeONHANDAGE日异动Transaction DayTRANSDAY物料搬运单Move OrderMOVEORDER装箱单Inventory Package OrderPACKAGEORDER子库存转移Subinventory TransactionSUBINVTRANS客户预付款帐龄Customer BalanceCUSTBALANCE对账单Match StatementsMTCHR采购订单打印Purchasing Orders PrintPOPRINT订单汇总Order SummaryORDERSUM订单明细汇总Order Summary DetailsORDERSUMDET报价成本核算Price Cost PCT发票打印Invoice PrintINVPRINT应收帐明细报表Receivables DetailsARDETAIL进销存Inventory in out storeINVINOUTSTOR月盘点Month inventoryINVMONTH客户退货Customer ReturnCUSTRETURN采购退货Po ReceiptPORECEIPT材料替代查询-描述查询DESCRIPTION_REPLACEDESREPLACE材料替代查询-料号查询ITEM_REPLACEITEMREPLACE挑库Pick RelesePICKER物料清单导入BOM list importBOMIMP预付款AP PrepaymentAPPREPAY销售明细AR Sales DetailsARTXN现金流量GL Cash FlowCASHFLOW2、数据库命名规范2.1表空间系统表空间系统表空间不存放业务数据，只供数据库本身使用。使用系统预定义名称。即SYSTEM，SYSAUX，TEMP，UNDO。如存在多少UNDO或者TEMP表空间，可使用定义：UNDO/TEMP + _ +表空间描述英文缩写。如UNDO_RAC90。用户表空间用户表空间面向实际用户。存放真正的业务数据。用户数据表空间存放用户数据表。定义：用户名+ _DATA。用户索引表空间存放用户索引定义：用户名+ _IDX。用户临时表空间存放用户临时创建的表定义：用户名+ _TMP_ +表空间内容英文缩写。表空间数据文件表空间对应多个数据文件。对使用裸设备文件的情况不适用。定义：表空间名+ _ + 两位数序序号+ .dbf 。如BILL_DATA_STAT_01.dbf表示BILL用户下的STAT数据表空间的第一个数据文件。2.4 表相关表名表名定义：CUX_+系统模块英文缩写+ _ +表含义英文缩写。如：CUX_SYS_DEPTS表示系统管理的部门信息表。对于多语言表必须在英文缩写后加_T每个用户模式一般代表一个子系统，对于用户下表可使用系统模块名进行分类。列名列名定义：表含义英文缩写+ _ + 列含义英文缩写。如：对于CUX_SYS_DEPT_T表，DEPT_ID表示部门编号，DEPT_NAME表示部门名称。如果相同含义的列名在多张表中出现，参考Oracle，名称与基本信息表中主键列名相同（不必要硬性要求创建主键），字段需要加备注。如：用户信息表CUX_SYS_USER_T中存在对部门的关联。部门编号的名称，仍然采用部分基本信息中的DEPT_ID。主键名主键名定义：CUX_ +系统模块英文缩写+ _ +表含义英文缩写+ 主键含义英文缩写。系统模块英文缩写+ _ +表含义英文缩写+_PK相同与对应表名，只是将“_T”去掉。如：CUX_SYS_DEPT_DEPTID_PK，DEPTID表示部门编号的主键信息。外键名外键名与主键名相似。定义：CUX_ +系统模块英文缩写+ _ +表含义英文缩写+ 外键含义英文缩写+_FK。CHECK约束同上。定义：CUX_ +系统模块英文缩写+ _ +表含义英文缩写+ CHECK约束含义英文缩写+_CF。UNIQUE约束同上。定义：CUX_ +系统模块英文缩写+ _ +表含义英文缩写+ UNIQUE约束含义英文缩写_UQ。索引名同上。定义：CUX_ +系统模块英文缩写+ _ +表含义英文缩写+ 索引名英文缩写+_ IDX。如： CUX_SYS_DEPT_DEPTID_ IDX是在CUX_SYS_DEPT_T表DEPT_ID创建索引。视图定义与表名规则相似。定义：CUX_ +系统模块英文缩写+ _ +视图含义英文缩写+_V。对于多语言视图在英文缩写后加后缀 _VL如上对应的源文件保存为.sql 格式。2.5 PL/SQL对象名PL/SQL对象包含过程，函数与包。过程定义与表名规则相似，因为Ebs中程序对象非常对，尽量不要使用独立的过程。定义：CUX_ +系统模块英文缩写+ _ +过程含义英文缩写+_P。如： CUX_PO_DETAIL_P源文件保存为：CUX_PO_DETAIL_P.prc函数定义与表名规则相似，因为Ebs中程序对象非常对，尽量不要使用独立的函数。定义：CUX_ +系统模块英文缩写+ _ +函数含义英文缩写_F。源文件保存为：CUX_PO_DETAIL_F.fnc包定义与表名规则相似。定义：CUX_ +系统模块英文缩写+ _ +包含义英文缩写。对于包内的函数过程命令同样使用上述标准+_XXX。XXX分别对应：模块工具包UTL私有包PVT公用包PUB报表程序包RPT一般程序包PKG如：CUX_PO_DETAIL_PKG源文件保存为：CUX_PO_DETAIL_PKG.PCK2.6其他对象角色名定义：CUX_ +角色含义英文缩写+_ROLE。序列名定义与表名规则相似。定义： CUX_ +系统模块英文缩写+ _ +序列名含义英文缩写+_ S。同义词定义与表名规则相似。定义： CUX_ +系统模块英文缩写+ _ +同义词含义英文缩写。数据库链定义与表名规则相似。定义：CUX_ +远程主机描述+ _ +远程数据库名_ LINK。如： CUX_GIS_SERVGIS_ LINK表示GIS主机上的SERVGIS数据库。3、SQL规范SQL语句分为关键字与非关键字两部分。关键字部分小写，其他部分大写。对于大部分语句格式缩进可使用PL/SQL Develop自带的格式化功能。语句格式示例：3.1 CREATEcreate table CUX_ARC_ACCT_T(ACCT_ID number(10),ACCT_NAME varchar2(10),ACCT_DATE date);3.2 SELECTselect * from CUX_ARC_ACCT_T where (ACCT_ID = 1 or ACCT_ID 1000) and ACCT_DATE = sysdate;3.3 INSERTinsert into CUX_ARC_ACCT_T values (1, test, sysdate);3.4 UPDATEupdate CUX_ARC_ACCT_T set ACCT_NAME = test02 where ACCT_ID = 1;3.5 DELETEdelete from CUX_ARC_ACC_T where ACCT_ID = 1;5、PL/SQL开发规范PL/SQL开发主要包过程，函数与包。5.1代码PL/SQL代码格式化缩进采用PL/SQL Develop工具。代码中出现的关键字使用小写。非关键字使用大写。如：begin update CUX_ARC_ACCT_T set ACCT_NAME = test02 where ACCT_ID = 1; commit;end;5.2对象名有关过程，函数与包的命名参见“第二章数据库命名规范”。5.3参数过程与函数都可以接收参数。参数名定义：p_ + 参数名含义英文缩写。参数名含义英文缩写全部使用小写。如：p_deptid 传递部门编号，p_acctname传递帐目名称。5.4变量常量变量常量定义只能固定存放于declare与begin之间。变量定义：变量类型英文标志+变量英文含义。常量定义：C_ + 常量类型英文标志+常量英文含义。变量常量英文含义首字母大写，其余小写。类型英文标志对照表：类型英文标志NUMBERiVARCHARsCHARcDATEdCURSORcurRECORDrecCOLLECTIONtblEXCEPTIONerr如：declare iDeptid number(10); sDeptname varchar2(19); C_dDeptdate constant date := sysdate;begin null;end;6、Operation System Files(操作系统档案)Operating System Files（操作系统档案）Object TypeName FormatExplanationExampleCommentsFormCUXMMMFSSS.fmbF:= FormSSS =序号CUXGLF001.fmbReportCUXMMMRSSS.rdfR:= ReportSSS = 序号CUXGLR001.rdfSQL concurrent programPL/SQL concurrent programCUXMMMPSSS.sqlP:= SQL, PL/SQLSSS = 序号CUXGLP001.sqlDatabase Trigger install scripttable_TRG.trgtable = Table名称TRG = TriggerCUX_XXXX_TRG.plsSQL*Loader scriptCUXMMMLSSS.ctlL:= LoaderSSS = 序号CUXGLL001.ctlUnix shellCUXMMMXSSS.shX:= ShellSSS = 序号CUXGLX001.shDatabase Object Create ScriptCUXMMMTSSS.sctT:= Create ScriptSSS = 主档名，亦即客制程式编号CUXGLT001.sct 7、OAF开发规范 命名空间定义： cux.oracle.apps.模块关键字.OAFSSS 其中SSS表示第一个用001,第二个用002,以此类推. OAF 对应上传AP服务器路径：$JAVA_TOP/ cux/oracle/apps/模块关键字/模块关键字参见系统模块英文缩写对照表示例。8、Applications Objects(系统对象)Object TypeName FormatExplanationExampleCommentsApplications Objects（系统对象）FormCUXMMMFSSSCUXMMFSSS = 程序主文件名，亦即客制程式编号 CUXGLF001User Form NameCUXMMMFSSS_VerbCUXMMMFSSS = 程序主文件名，亦即客制程式编号Verb= 程序名称CUXOMF001ZHS_Maintain OrdersFunctionCUXMMMFSSS_desc_FCUXMMMFSSSLAN = 程序主文件名，亦即客制程式编号desc= 简述F = FunctionP = Procedure若该程序只有一个Function，则为CUXGLF0001_F若该程序有多个Function，则设为CUXGLF001_ENT_F CUXGLF001_QRY_FUser Function NameCUXMMMFSSS_VerbCUXMMMFSSS = 程序主文件名，亦即客制程式编号Verb= Function说明CUXGLF001_Enter_Funds,CUXGLF001_Query_FundsExecutable name & Short nameCUXMMMFSSS_descCUXMMMFSSS = 程序主文件名，亦即客制程式编号Desc= Concurrent程序名称CUXGLP001Concurrent program short nameConcurrent Program Executable nameConcurrent Program Executable名称，亦即客制程式编号CUXGLP001Concurrent program nameCUXMMMFSSS_descPMMMFSSS = 程序主文件名，亦即客制程式编号Desc= Concurrent程序名称CUXOMR002_Orders Summary by VendorCUXOMR003_Orders Detail by VendorProfile nameCUX_MMM_profileProfile= Profile名称CUX_GL_DEFAULT_STATUSUser profile nameCUX:MMM: profileProfile= Profile详细名称CUX: GL:Default Fulfillment StatusDescriptive flexfieldCUX_MMM_descDedsc= 弹性字段用途说明CUX_GL_XXXXDescriptive Flexfield之Name需命名为此以利相关客制弹性字段的撷取汇整Report group nameResponsibility GRPResponsibility = Responsibility KeyCUXXXXX_GRPReport group codeCUX_descdesc = Report Group说明CUX_XXXXRequest setsCUXMMMTSSS_descCUXMMMTSSS = 主档名，亦即客制程式编号descRequest set说明CUXOM001_Orders Request SetResponsibilitiesCUX- descdesc = Responsibility说明CUX_