Friday, September 25, 2015

GENERAL NAMING CONVENTION IN OAF

GENERAL NAMING CONVENTION IN OAF



File Name length:-
File names are limited to 30.3 characters for OA Extension XML files (50.java for Java files).

Object Name length (regions, items, and so on):–

           For performance reasons, object names (internal ID’s) are limited to 30 characters.
           Common abbreviations are acceptable to keep names as short as possible.
          Acceptable abbreviations can be instantly understood by a third party consultant.
          Object names in pages must be unique in the entire page.
          Most names follow Java naming convention (mixed case).

Naming Standards for a Page:- The page name should convey the object it Presents.
            Page name ends with PG:- <object name>PG
            For ex:-    EmpSearchPG,  EmployeePG,  SupplierPG

Naming Standards for a Region:- The region name should convey the object it Presents.
            Region name ends with RN:- <object name>RN
            For ex:-   MainRN,  EmpSearchRN,PoHeaderRN

Naming Standards for an Object:-
                        EmpName,,,SearchEmpName,,ResultsEmpName

Naming Standards for an Entity Object:- The EO should be named for the objects stored in its 
                                                                     underlying entity.
            Entity Object name ends with EO:- <EntityName>EO
            For ex:-  EmployeeEO,    SupplierEO,   PurchaseOrderHeaderEO.

 Naming Standards for an Entity Association Object:-The AO name should convey the relationship between a parent and its child entities.

            Entity Association name ends with AO:-<parent>TO<child>AO
            For ex:- PoHeaderToLinesAO,   SupplierToSitesAO, DepartmentToEmployeeAO

Naming Standards for a View Object:-The VO name should convey the nature of  the query.
View Object name ends with VO:- <Descriptive Name>VO
For ex:-  EmployeeVO,  SupplierVO, PurchaseOrderVO.

Naming Standards for a View Link:- The VL name should convey the relationship
 between the master and detail VOs.
View Link name ends with VL:- <Master>To<Detail>VL

For ex:- EmployeeToDepartmenstVL,    PoHeaderToLinesVL

 Naming Standards for an Application Module:- The AM name should convey the purpose of the                                                                                     UI  module it services.

Application Module name ends with AM:-  <ModuleName>AM

For ex:-HelloWorldAM,   EmployeesAM,  SupplierAM.

No comments:

Post a Comment

Clear BNE Cache for WebADI Changes

It Sometime happens that WebAdi Changes doesn't reflect once migrated in controlled instances. Here are the quick steps(Generally perfor...