Nomenclature Guidelines Change History Version 1.0 1.1 Date 15-02-2023 24-04-2023 Author Note Initial Draft Final Preface Purpose of this document The purpose of this document to follow a common set of nomenclature to develop any object or to make any changes into existing program or in SAP given program. The intention is to maximize the quality, value and maintainability of each custom solution proposed by the company. Thus, it is essential that each SAP person performing programming activities familiarize him/herself with, and adheres to these common set of standard. Program/Report Name <PREF><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <PREF> Len-1 ‘R’ For Report, M For Module Pool, F for Function Module. <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. <TEXT> Len-26 Descriptive text Note: For the program attributes Title, it is recommended to prefix the description with the FS/CR object ID (if available). Configuration custom Table <PREF><AREA><T><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. <T> Len-2 ‘_T’. It’s mandatory for configuration table <TEXT> Len-Any Descriptive Text Structure <PREF><AREA><TEXT><S> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. <TEXT> Len-Any Descriptive Text <S> Len-2 ‘_S’. It’s mandatory for configuration table Table Type <PREF><AREA><TEXT><T> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. <TEXT> Len-Any Descriptive Text <T> Len-2 ‘_T’. It’s mandatory for configuration table Implicit or Explicit Enhancement <PREF><AREA><E<NN><_><PROGRAM NAME> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. E<NN> Len-3 <NN> can be any number starting from 01 like E01, E02 <_> Len-1 “_” Underscore <PROGRAM NAME> SAP Standard program name Like Ex- ZSDE01_MV45AFZZ Data Type Data type Prefix Table Control TC_* TC_CONTROLDATA Tab strip TS_* TS_DETIALS Custom Controller CC_* CC_ALV Suffix Description/Example Use the following naming conventions for specific data types: Data type Prefix Suffix Description/Example SELECT-OPTIONS S_ PARAMETERS P_ Global data... Gx Internal table GT_ Structure / work area GS_ GS_USR05 TYPE USR05 GS_USR05_CURRENT Type GTY_ GTY_DATATAB Variables GV_ Constant GC_ GV_BNAME TYPE XUBNAME GV_COUNTER TYPE I GC_TRUE Range tables GRT Local data... Lx_ Formal parameters in Subroutines... Px_ “x” to be replaced as outlined Below Like DDIC table and/or Referring to custom obj. GT_EKKO RANGES GRT_BUKRS FOR T001BUKRS “x” to be replaced as outlined below – same logic as explained for global fields: LT_, LS_, LV_, LRT_ … “x” to be replaced as outlined below – same logic as explained for global fields: Data type Prefix Type declaration TY_ Suffix Description/Example PT_, PS_, PV_, PRT_ Table type declaration Import fields in function modules or methods TTY_ Ix_ Export / returning fields in function modules or methods Ex_ Changing fields in function modules or methods Cx_ Push Button Radio Button Check Box PB_* Field Symbols <FS_> Function Group <PREF><AREA><TEXT> <PREF> Len-1 <AREA> Len-2 <TEXT> Len-Any RB_* CB_* TYPES TY_EBAN TYPE EBAN TYPES TTY_EBAN TYPE TABLE OF TY_EBAN “x” to be replaced as outlined below – same logic as explained for global fields: IT_, IS_, IV_, IRT_ “x” to be replaced as outlined below – same logic as explained for global fields: ET_, ES_, EV, ET_ “x” to be replaced as outlined below – same logic as explained for global fields: CT_, CS_, CV, CT_ PB_BUTTON1 RB_OPTION1 CB_CHECK1 Field symbols. ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Function Module <PREF><_><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <_> Len-1 ‘_’ Underscore is mandatory <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. <TEXT> Len-Any Descriptive Text Include Include naming is situation specific. The following are suggestions but developers may deviate from these suggestions when appropriate <PREF><AREA><PROGRAM><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc. <PROGRAM> Len-Any Name of the program <TEXT> Len-Any Descriptive text Append Structure for SAP Standard table <PREF><SAP><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <SAP> SAP Table or structure name <TEXT> Len-Any Descriptive Text Area Menu <PREF><TEXT> <PREF> Len-1 <TEXT> Len-Any For Ex: For RICEF For RICEEF Enhancement Message Class <PREF><AREA><TEXT> <PREF> Len-1 <AREA> Len-2 <TEXT> Len-Any Screen Number <NNNN> <NNNN> ‘Z’ for production and ‘Y’ for Local Object or Testing object Name + Suffix ‘E’ for menu enhancement ID ZAREAMENU1 ZS0000E ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Number must be between 9000 to 9999 Transaction Code <PREF><AREA><TEXT> <PREF> Len-1 <PREF> Len-1 <AREA> <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing ‘R’ For Report, M For Module Pool, T for Table Name. SD/MM/FI/PM/QM/PS etc. Descriptive Text Domain <PREF><TEXT> <PREF> Len-1 <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing Descriptive Text Data Element <PREF><TEXT> <PREF> Len-1 <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing Descriptive Text Search Help <PREF><AREA><TEXT> <PREF> Len-1 <AREA> <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Custom or any Z Table <PREF><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> <TEXT> Len-Any SD/MM/FI/PM/QM/PS etc. Descriptive Text Table Index <PREF><NN > <PREF> Len-1 <NN> ‘Z/T’ for production and ‘Y’ for Local Object or Testing any number starting from 01 Custom View <PREF><AREA><TEXT> <PREF> Len-1 <AREA> <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Lock Object <E><PREF><AREA><TEXT> <E> Len-1 ‘E’ <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> SD/MM/FI/PM/QM/PS etc. <TEXT> Len-Any Descriptive Text BAPI Method (Custom) <PREF><AREA><TEXT> <PREF> Len-1 <AREA> <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text BAPI Method (SAP Modified) <PREF><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <TEXT> Len-Any Text/Object name (Use original SAP defined method name) BAPI Function Module (Custom) / SAP Modified <PREF><BAPI><_><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <BAPI> Len-5 <_BAPI> <_> Len-1 <_> Underscore <TEXT> Len-Any Descriptive Text Smartform Name <PREF><AREA><TEXT> <PREF> Len-1 <AREA> Len-2 <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Style <PREF><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> <TEXT> Len-2 Len-Any SD/MM/FI/PM/QM/PS etc. Descriptive Text LOGO <PREF><TEXT> <PREF> Len-1 <TEXT> Len-Any ‘Z’ for production and ‘Y’ for Local Object or Testing Descriptive Text Projects (CMOD) <PREF><AREA<TEXT> <PREF> Len-1 <AREA> Len-2 <TEXT> ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Package <PREF><AREA<TEXT> <PREF> Len-1 <AREA> Len-2 <TEXT> ‘Z’ for production and ‘Y’ for Local Object or Testing SD/MM/FI/PM/QM/PS etc. Descriptive Text Number Range Object <PREF><AREA<NNN><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <NNN> Len-3 any number 001 002 003 <TEXT> Descriptive Text Classical/New BAdi Implementation <PREF><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Workflow Template <PREF><WS><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WS> Len-2 WS <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Task Group <PREF><WTG><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WTG> Len-3 WTG <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Standard Task <PREF><WTS><DB><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WTS> Len-3 WTS <DB> Len-1 D for dialog and B for background <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Attribute <PREF><WA><D><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WA> Len-2 WA <D> Len-1 D for database attribute, V for virtual and S for Status <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Event <PREF><WE><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WE> Len-2 WE <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Method <PREF><WM><A><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WM> Len-2 WM <A> Len-1 D -> Dialog, S-> Dialog + Synchronous, B->Background <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Key Field <PREF><WK><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WK> Len-2 WK <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Interface <PREF><WIF><AREA><TEXT> <PREF> Len-1 ‘Z’ for production and ‘Y’ for Local Object or Testing <WIF> Len-3 WIF <AREA> Len-2 SD/MM/FI/PM/QM/PS etc <TEXT> Descriptive Text Object Type <PREF><WO><AREA><TEXT> <PREF> <WO> <AREA> <TEXT> Len-1 Len-2 Len-2 ‘Z’ for production and ‘Y’ for Local Object or Testing WO SD/MM/FI/PM/QM/PS etc Descriptive Text For all new development below flower box must be maintained proper and it is mandatory for developer *REPORT/PROGRAM NO STANDARD PAGE HEADING * LINE-SIZE XX * LINE-COUNT XX * MESSAGE-ID ZZ. *--------------------------------------------------------------------*--------------------------------------------------------------------* Revision History-----------------------------------------------------* * Revision No: <Transport No> * Developer, Date : <ID>, DD-MM-YYYY * Description: * Modification ID: MOD-XXX *-------------------------------------------------------------------* *----------------------------------------------------------------------* * Program Description: * Developer: * Creation Date: YYYY-MM-DD * Transport Number(s): *----------------------------------------------------------------------* To change into existing program for any incident, it is mandatory to put comment like below Begin of <Incident No> <Date> <User ID> <Description> End of <Incident No> <Date> <User ID> If making changes in existing program through CR then use MOD technique First in flower box maintain history MOD like MOD-001, MOD-002 Then at the place where coding is going to change Begin of MOD<NNN> End of MOD<NNN>
0
advertisement
Download
advertisement
Add this document to collection(s)
You can add this document to your study collection(s)
Sign in Available only to authorized usersAdd this document to saved
You can add this document to your saved list
Sign in Available only to authorized users