itc abap naming conventions

Project <ABAP/4 Naming Conventions>

ABAP/4 Naming Conventions

1 of 21


Document Control

Author PricewaterhouseCoopers

File Name ITC ABAP Naming Conventions.doc

Path

Created 29 February, 2000

Last Edited 29 February, 2000

Number of Pages 19

Version Revision Date Revision Description Author Sign-off

0.1 29/02/2000 Initial Release Milan Day

0.2

Target Readership

Project Management Team

Technical Team Members

2 of 21


Table of Contents

ABAP/4 Naming Conventions.........................................................................................................................11.0 Introduction..........................................................................................................................................42.0 Object naming conventions..................................................................................................................5

Summary.......................................................................................................................................................5Program Element:.........................................................................................................................................8Program Element..........................................................................................................................................8Development Class.......................................................................................................................................9ABAP Program.............................................................................................................................................9Report Variant..............................................................................................................................................9Transaction Codes:.....................................................................................................................................10ABAP module Pools:.................................................................................................................................10Module Pool Includes:................................................................................................................................11Dynpros (Screen)........................................................................................................................................11SPA/GPA Parameters.................................................................................................................................11Batch Job Requests.....................................................................................................................................12Batch Input Sessions...................................................................................................................................12Area Menus................................................................................................................................................12Function Key..............................................................................................................................................13Titlebar.......................................................................................................................................................13Transparent Tables:....................................................................................................................................13Domains......................................................................................................................................................14Data Elements.............................................................................................................................................14Search Helps...............................................................................................................................................14Data Element Supplement..........................................................................................................................15Table Fields................................................................................................................................................15Lock Objects...............................................................................................................................................15Function Groups.........................................................................................................................................15Function Modules.......................................................................................................................................15Messages Classes and Number...................................................................................................................16Number Range............................................................................................................................................16Layout Sets.................................................................................................................................................16Standard Texts............................................................................................................................................17Styles..........................................................................................................................................................17

3.0 Appendices...............................................................................................................................................18Module ID & Sub-Module ID :..................................................................................................................18Program Type Ids.......................................................................................................................................19

3 of 21


1.0 Introduction

Using consistent development standards and naming conventions through SAP technical development will not only contribute significant time and resource savings for both the initial construction and long term maintenance of SAP system, but also improve system efficiency dramatically. Developing these standards prior to construction and adhering to them during construction is especially helpful when addressing the following:

Migration into a production environment Long-term maintenance of custom development Future upgrades Facilitating knowledge transfer for future SAP resources

Small amounts of effort now will provide beneficial for the overall project and SAP System. The objective of this manual is to define guidelines for SAP developers.

This document is based on : SAP’s Naming Convention for Development Objects Previous PwC SAP project implementation standards

This document will further evolve as batch scheduling and mapping tools are more solidly integrated into Project SAPling’s development environment, and as new requirement/standards arise.

4 of 21


2.0 Object naming conventions

SummaryThe following table summarizes the naming conventions described in this document. Each SAP Object type if described in further detail in following sections. Note that capital letters represent literals and should not be changed. Lowercase letters represent variable fields which may take on some range of values described in the appropriate section.

SAP Object Type Length Naming ConventionABAP Programs 9 Yabccxxxx

a - Program Type Id (see appendices)b - Module Id (see appendices)c - Sub Module Id (see appendices)x - Open

ABAP Report Include 9 Yibccxxxxb - Module Id (see appendices)c - Sub Module Id (see appendices)x - Open

ABAP Report Variant 14 x - OpenTransaction Codes 4 ga99

g - Y or Za - application code (see appendices)99 - number from 01 to 99

ABAP Module Pools 30 SAPxZannnnnnnnnnnnnnnnnnnnnnnnx – Type of module pool

M – ScreensL – Function ModuleF – SubroutinesD – Dialog

a – Module Idn – Descriptive Text

ABAP Module Pool Includes 30 xZannnnnnnnnnnnnnnnnnnnnnnnTOP – Top IncludexZannnnnnnnnnnnnnnnnnnnnnnnOyy – PBO modulesxZannnnnnnnnnnnnnnnnnnnnnnnIyy – PAI ModulesxZannnnnnnnnnnnnnnnnnnnnnnnFyy – Subroutinesx – Type of module pool

M – ScreensL – Function ModuleF – SubroutinesD – Dialoga – Module Idn – Descriptive Text

y - Open (Numeric : 0 – 99)Dynpros (Screens) 4 9nnn

nnn – Numeric between 000 and 999SPA/GPA Parameters 3 gxx

g – Y or Zx – Descriptive Text

Batch Job Requests 32 Z_bb_a_xxxxxxxxxxxxxxxxxxxxxxxxxb – Frequency Indicator

5 of 21


da – Dailywk – Weeklymn – Monthlyqt – Quarterlyan – Annuallyre – On Request

a – Application IDx – Descriptive Text

Batch Input Sessions(BDC Sessions)

12 Yxxxxxxxx_nnYxxxxxxxx – ABAP program submitting the BDC Sessionn – Sequential Number

Area Menus 20 gaxxxxxxxxxxxxxxxxxxg – Y or Za – Module Idx – Descriptive Text

Function Key Codes 4 xxxxx – Open

Titlebars 3 xxxx – Open

Tables, Views, Structures 16 gaxxxxxxxxxxxxxxg – Y or Za – Module Idx – Descriptive Text

Domains 30 ZZxxxxxxxxxxxxxxxxxxxxxxxxxxxxx- Descriptive Text

Data Elements 30 ZZxxxxxxxxxxxxxxxxxxxxxxxxxxxxx- Descriptive TextShould use the same name in both Domain and Data Element

Data Element Supplements 34 ZZxxxxxxxxxxxxxxxxxxxxxxxxxxxxnnnn x name of the corresponding Data Elementn range between 0001 to 9999

Table Fields 16 ZZxxxxxxxxxxxxxx (Attached to SAP delivered tables)xx – Descriptive Textxxxxxxxxxxxxxxxx (Attached to custom tables)xx – Descriptive Text

Search Helps 30 gat_xxxxxxxxxxxxxxxxxg Y or Za Module Id (see appendices)t type

E – ElementaryC – Composite

x descriptive textLock Objects 16 Eg_xxxxxxxxxxxxx

g Y or Z x Primary Table Name (where multiple Lock Objects are required for the same primary table, assign a unique digit to the final position )

Function Groups 26 Ya_xxxxxxxxxxxxxxxxxxxxxxxa Module ID (see appendices)x descriptive text

Function Modules 30 Ya_xxxxxxxxxxxxxxxxxxxxxxxxxxx

6 of 21


a Module Id (see appendices)x descriptive text

Message Classes 20 ga_xxxxxxxxxxxxxxxxxg Y or Za Module Id (see appendices)x descriptive text

Message Number 3 nnnnnn – Number Interval 001 – 999

Number Range Object 10 ga_xxxxxxxg Y or Za Module Id ( see appendices)x Descriptive Text

Layout Sets (SAPScript) 16 gabb_xxxxxxxxxxg Y or Za Module Id (see appendices)b Sub Module Id (see appendices)x Descriptive text

Standard Texts 32 ga_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxg Y or Za Module Id (see appendices)x descriptive text

Styles 8 ga_999g Y or Za Module Id (see appendices)9 Number from 001 to 999

7 of 21


Program Element:

Program Element Use SyntaxInternal Tables Internal tables: Standard I_*

Internal tables: Sorted IS_*Internal tables: Hashed IH_*Copy of database table IY_* or IZ_*

Structures Intermediate Storage X_*Screen Elements Radio Buttons

Push ButtonsCheck Boxes

RB_*PB_*CB_*

Types General TY_*Constants General C_*Parameters (all kinds) General P_*Ranges General R_*Forms General Sub_*Select Options General S_*Variables Global G_*

Local L_*

Note: The asterisk in the table above signifies a descriptive name of your choosing. Consider using an underscore (_) to connect multi-word variable and multi-world FORM names.

8 of 21


Development Class

Development Classes group together development objects (e.g. programs, tables, function modules ) which can be corrected and migrated together across instances. A development class can, for example, consist of a transaction or a group of related transactions along with programs, DDIC objects, menu painters, screen painters, lock objects, message classes ,match codes, etc.

All custom development should be assigned to a custom development class. Temporary objects may be assigned to class ‘$TMP’. Objects defined under $TPM development class will not be migrated.

Class Description$TPM Local Objects (not migrated)ZBAS BasisZCFG ConfigurationZDCV General DevelopmentZFRM FormsZINT InterfacesZRPT Reports

ABAP Program

The maximum length of an ABAP program name is 30 characters. SAP requires that the first character begin with a ‘Z’ or ‘Y’. For all programs in this project the first character will be always a ‘Y’. The second character signifies what kind of program it is. The next three characters identify the Application process ID, which comprises of Module ID and sub-module ID. The last 26 characters of the program name are open for any alphanumeric string. For all purposes in project SAPLing we will follow the length of program name to be 9.

Yabccxxxxa - Program Type Id (see appendices)b - Module Id (see appendices)c - Sub Module Id (see appendices)x - Open

ABAP Report Include

For all report include programs in this project the first character will be always a ‘Y’. The second character will be ‘I’. The next three characters identify the Application process ID, which comprises of Module ID and sub-module ID. The last 26 characters of the program name are open for any alphanumeric string. For all purposes in project SAPLing we will follow the length of program name to be 9.

YIbccxxxxb - Module Id (see appendices)c - Sub Module Id (see appendices)x - Open

Report Variant

Naming convention

9 of 21


When an ABAP report is created, ABAP may generate some database-specific selections on the selection screen. Additional selection-screen criteria can also be programmed into the report. In order to execute a report for a specific range of data or selection set, the selection ranges must be entered on the screen. However, if there is a requirement to run the same report with the same selection set, especially in batch, a variant can be used to save that selection set. If a variant is used, there is no need to enter the same selection set again each time the report is executed.

The maximum length of an ABAP variant is 14 characters. Report Variants should adhere to the following naming convention:

xxxxxxxxxxxxxx

Transaction Codes:

Transaction Codes are created either through ABAP Development Workbench/Development/Other Tools/Transactions or if you are developing a transaction you can create a transaction code there itself. Every transaction in SAP contains a unique transaction code. Information about all transactions are stored in two standard SAP tables. Table TSTC contains the attributes of the transaction and table TSTCT contains the short text associated with the transaction. The entries in tables TSTC and

10 of 21


TSTCT are created by SAP when a transaction code is successfully saved.

A transaction code can be up to 20 characters. For Project SAPling transaction codes will be limited to a length of 4. The naming convention for transactions created by Project SAPling’s developers requires the first character be a ‘Y’ or a ‘Z’. The Module ID is placed in the second character. The remaining characters are open to the developer.

ga99 g - Y or Za - application code (see appendices)99 - number from 01 to 99

ABAP module Pools:

An ABAP module pool is an ABAP program that checks and processes what a user enters during a transaction. It is thus part of on-line programming. An ABAP module pool groups together the modules that process common data. Module pool names can be up to 30 characters long and must begin with ‘SAPxZ’ (where x can be ‘M’ for screen modules, ‘D’ for dialog modules, ‘F’ for subroutine modules and ‘L’ for Function Modules). The next character represents the Module ID and the next two positions contain a numeric value or a descriptive text. For ‘M’ type module pools, the last 20 characters of the program name should be identical to the primary transaction code created

11 of 21


for that module pool.

SAPxZannnnnnnnnnnnnnnnnnnnnnnnx – Type of module pool

M – ScreensL – Function ModuleF – SubroutinesD – Dialog

a – Module Idn – Descriptive TextExample SAPMZD01

Module Pool Includes:

Naming conventions for Module Pool components must also adhere to SAP standards. See table below for detailed conventions using the above example - Module Pool Type

‘L’ for function modules

‘M’ for screen modules

‘D’ for dialog modules

‘F’ for subroutine modules

a - Module Id

(Note: xZann in conventions below should match xZann in main Module Pool name).

Module Pool Component TypeData Definition (Global Data Include) Module

xZannTOP

Process Before Output (PBO) Module

xZannOyy

Process After Input (PAI) Module

xZannIyy

Performs (subroutines) xZannFyyProcess On Help-Request (POH) Module

xZannHyy

Process On Value-Request (POV) Module

xZannVyy

Forms for OKcode functions Form_<Okcode>

12 of 21


Remarks: It is strongly recommended that you use the ‘SAP Workbench’ to construct module pools. The SAP Workbench is designed to enforce standard naming conventions.

Dynpros (Screen)

SAP screens are referred to as dynpros. Standard SAP components, such as transactions, menus and tables, contain dynpros and the associated processing logic. The identification of a screen painter dynpro consists of an ABAP program name and a 4-digit dynpro number. The number range reserved for dynpros should be between 9000 - 9999. The initial screen number for a given transaction should be 9000 and additional screens numbers increment by 10. If there are any pop up screens their number should be maintained as an increment of 1 on the main screen no.

Example Module Pool: SAPMZF01Screen #: 9000

SPA/GPA Parameters

A field can be filled with proposed values from SAP memory using a parameter ID. These have to be mentioned as field attributes in a module pool program.

gxxg – Y or Zx – Descriptive Text

Batch Job Requests

The maximum length of a batch job request is 32 characters. Batch job requests should adhere to the following naming convention :

Z_bb_a_xxxxxxxxxxxxxxxxxxxxxxxxxb – Frequency Indicator

da – Dailywk – Weeklymn – Monthlyqt – Quarterlyan – Annuallyre – On Request

a – Application IDx – Descriptive Text

Batch Input Sessions

Batch input sessions are a collection of batch input data used as input to one or more update transactions. External data can be transferred into the SAP system through a batch input session. They are stored on the batch input queue until submission to the transaction processing. In order to guarantee data consistency, all data is subject to the same validations performed in the on-line transaction.

13 of 21


Batch input session names can be up to 12 characters long. It should start with the name of the primary program that created the session. The remaining characters should be a running serial no.

Yxxxxxxxx_nnYxxxxxxxx – ABAP program submitting the BDC SessionN–SequentialNumber

Area Menus

An area menu is the first menu that appears when entering an ‘application area’. For example, selecting Tools ABAP Workbench will take you to the ABAP Workbench area menu and the ABAP Workbench application area. The application area can also be accessed via transaction code S001. The area menu name is the transaction code S001.

The area menu follows the same naming conventions as transaction codes. The maximum length of an area menu is 20 characters.

gaxxxxxxxxxxxxxxxxxxg – Y or Za – Module Idx – Descriptive Text

Function Key

Function keys are part of the GUI status and are defined in the menu painter along with pushbuttons and menu items. SAP has certain standard settings for some function keys, listed below:

F1 HelpF2 ChooseF3 Back (one step)F4 Possible entriesF9 SelectF10 Jump to menu barF11 Save/GenerateF12 CancelShift-F1 PrintShift-F2 DeleteShift-F5 Open

SAP also uses the following function keys for scrolling:

Shift-F9 First PageShift-F10 Previous PageShift-F11 Next PageShift-F12 Last Page

xxxxx – Open

Titlebar

Used to give a heading to a window. The content can be dynamically changed as per requirement.xxx

14 of 21


x – Open

Transparent Tables:

A Transparent table has a 1:1 relationship (field for field) with a corresponding physical table on the underlying database. Transparent tables are typically used to store master and transaction data.

A view can be used to create virtual tables that do not contain any data, but presents selected columns of data from one or more database tables. A structure is defined like a table, but it does not store records in the database. Structures can be shared by multiple ABAP programs.

The table and view name can be up to 16 characters long, whereas a structure can be of a length of 30 characters. All custom created Tables, Views and Structures will be maintained at length of 16 for this project. The first character should be ‘Y’ or ‘Z’. The second character should reflect the Module ID. The remaining characters are open and should be as descriptive as possible.gaxxxxxxxxxxxxxxg – Y or Za – Module Idx – Descriptive Text

Domains

A domain is a central object for describing the attributes of a business object. A domain describes the value set for a field. This set of values is defined by specifying the format attributes, such as external format, length and type.

The maximum length of a domain is 30 characters. The first two characters must be ‘ZZ’ and the remaining 28 characters can be arbitrarily assigned. ZZxxxxxxxxxxxxxxxxxxxxxxxxxxxxx- Descriptive Text

Data Elements

A data element is a semantic domain. It provides a precise description of the function of a domain in a specific business context for the fields that depend on it. Each new data element defined by a developer should be linked to a new domain. Existing SAP domains should not be used to define new data elements.

The maximum length for a data element is 30 characters. The first two characters must be ‘ZZ’ and the remaining 28 characters can be arbitrarily assigned.ZZxxxxxxxxxxxxxxxxxxxxxxxxxxxxx- Descriptive TextShould use the same name in both Domain and Data Element

Search Helps

As of SAP R/3 release 4.0, Matchcode Objects have been replaced by Search Helps. The search help concept simplifies and extends the past options for defining an input help (matchcode). Search Helps

15 of 21


must begin with the letters ‘Y’ or ‘Z’ and can be up to 30 characters long. Existing help views and matchcodes are automatically converted to Search Helps in a release upgrade to 4.0.

Note: Search Helps are ABAP dictionary objects and can be created at any point in the Repository Browser.

Search Helps are linked to data elements, check tables and structure fields. You can also define default values for input parameters using Search Helps. Search Help Exits are function modules that allow you to change the appearance and functionality of how the Search Help appears to the user, however it is recommended by SAP not to overuse Search Help Exits to preserve the integrity of regular Search Help process.

Note: Several Search Helps can be combined to form a collective Search Help. The user can then choose between several search options in the input help, as was the case or matchcodes.

gat_xxxxxxxxxxxxxxxxxg Y or Za Module Id (see appendices)t type

E – ElementaryC – Composite

x descriptive text

Data Element Supplement

ZZxxxxxxxxxxxxxxxxxxxxxxxxxxxxnnnn x name of the corresponding Data Elementn range between 0001 to 9999

Table Fields

Field names in SAP tables can be upto 16 characters. Whenever a field is added to an SAP supplied table, the convention followed is to start with ‘ZZ’ and then add some descriptive text, whereas for custom defined tables the naming convention is open.ZZxxxxxxxxxxxxxx (Attached to SAP delivered tables)xx – Descriptive Textxxxxxxxxxxxxxxxx (Attached to custom tables)xx – Descriptive Text

Lock Objects

Lock objects control simultaneous access to a particular table/entry by two update users. Locks are set and released by calling a function module. When a lock object is activated, the system automatically generates the function modules to be included in an ABAP program.

Lock object names can be up to 16 characters long and should start with the prefix ‘EZ_’. The remaining characters are open to the developer. For Project SAPling table name will be used for the remaining characters.

Eg_xxxxxxxxxxxxx

16 of 21


g Y x Primary Table Name (where multiple Lock Objects are required for the same primary table, assign a unique digit to the final position )

Function Groups

SAP function modules are programs written in ABAP that can be called by any ABAP program or the function modules themselves. They are managed centrally in the function library, which provides search, display, maintenance and printing capabilities for all standard and custom function modules.

Function modules are grouped together using function groups. SAP supplied function groups should never be assigned to new function modules.

Function group names are 26 characters long and must start with a ‘Z’. The next character will store the Module ID. The remaining 24 characters are open.Ya_xxxxxxxxxxxxxxxxxxxxxxxa Module ID (see appendices)x descriptive text

Function Modules

The function module name can be up to 30 characters long and must begin with ‘Z’. This will differentiate custom created function modules from standard SAP function modules. The remaining 28 characters must start with the module id and an underscore and should reflect the nature of the function. Underscores are used to separate words. Ya_xxxxxxxxxxxxxxxxxxxxxxxxxxxa Module Id (see appendices)x descriptive text

Messages Classes and Number

Messages are used in ABAP programs to send information to the user. There are six different types of messages: information, warning, error, abend, exit and success.

A message consists of a 20 character message class and a 3 digit message number. The first character of the message class should be a ‘Y’ or a ‘Z’ and the second character will contain the Module ID. The remaining 18 characters are open. The message number is open to any number between 000 and 999.

Message Class: ga_xxxxxxxxxxxxxxxxxg Y or Za Module Id (see appendices)x descriptive text

Message Number:nnnnnn – Number Interval 001 – 999

Number Range

17 of 21


Number ranges are used to assign numbers to individual database records for a commercial object, to complete the key. Such numbers are e.g. order numbers or material master numbers. The R/3 number range management also monitors the number status, so that numbers which have already been issued are not re-issued.All dialogs, database accesses or other activities which are necessary for the maintenance of number range objects and number ranges and number allocation in user developments, can be performed using SAP function modules.

The layout set name can be a maximum of 10 characters. It should start with a ‘Y’ or a ‘Z’. This is followed by the Module ID and the remaining characters are open to any alphanumeric combination.

ga_xxxxxxxg Y or Za Module Id ( see appendices)x Descriptive Text

Layout Sets

A layout set in SAPscript is used for page layout. The layout set contains various elements used for layout control. A layout set definition contains the following elements: Header Data, Paragraphs, Character Strings, Windows, Pages and Page Windows.

The layout set name can be a maximum of 16 characters. It should start with a ‘Y’ or a ‘Z’. This is followed by the Module ID and subsystem. The remaining ten characters are open to any alphanumeric combination.

gabb_xxxxxxxxxxg Y or Za Module Id (see appendices)b Sub Module Id (see appendices)x Descriptive text

Standard Texts

ga_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxg Y or Za Module Id (see appendices)x descriptive text

Styles

A style defines the set of paragraph and character formats that are available for formatting a document. A typical style contains, for example, a definition for a standard paragraph, list paragraph formats, and possibly special-purpose paragraph formats for headings, data in forms, and so on. A style also usually defines such character formats as boldface, italics, and so on. You can select from these formats to format your document. If you select a style, this style provides the character and paragraph formats for your document. Any formats defined in the form selected for a document are ignored.

Style Names can be upto 8 characters. They must begin with either a “y’ or a ‘Z’. This is followed by the module id and then by a running serial number.ga_999

18 of 21


g Y or Za Module Id (see appendices)9 Number from 001 to 999

19 of 21


3.0 Appendices

Module ID & Sub-Module ID :

For all development purposes, the application process ID will be a 3 character field which acts as an identifier for each program developed. This identifier can be used to group related programs and development objects together and may be used to give a distinct signature for interface control logic, reporting, and data file names.

The Application process ID will be divided into Module ID and a Sub-Module ID for further categorization and organization. See the table below for the Module ID and Sub-Module relationships:

Application Function

Module ID Sub-Module ID

Sub-Module Description

Financial Accounting FAP Accounts Payable AR Accounts receivable CF Common across FIED EDIFC Financial Controlling FM Funds management GL General Ledger LC Consolidation

Controlling CIO Internal OrdersCA Cost Center AccountingPC Product CostingPA Profitability Analysis

Production Planning PPD Plant Data CollectionAO Assembly OrdersPC Planning & Control - Rep. ManPO Production OrdersMR Material Requirements PlannCP Capacity PlanningMP Master PlanningSP Sales & Operations Planning

Quality Management QQP Quality PlanningQI Quality InspectionQC Quality ControlCA Quality CertificatesQN Quality Notifications

Materials Management MBD Basic data CM Common across MMED EDIIM Inventory Management

20 of 21


PI Purchasing Info systemIV Invoice VerificationPR Purchasing WM Warehouse Management SystemCB Consumption-Based Planning

Sales & Distribution VBD Basic data BI Billing CS Sales Support CX Common across SDED EDIIS Sales Info systemSH Shipping SL Sales SO Sales Order ManagementTR Transportation

Basis BCB Common across BASISIC Interface Control

Human Resources HBD Basic DataCC Common across HRPA Personnel AdministrationTI Time ManagementIW Incentive WagesBN BenefitsPY Payroll

Cross-Application Z ZZ Cross-Application

Test/Throw-away T ST Test/Throw-away

If it appears that a specific development object cannot be appropriately classified by the current list of Module IDs, a new Module ID should be requested from the Development Team Leader.

Program Type Ids

C ConversionG General Functionality/OtherI Inbound InterfacesO Outbound InterfacesM System Maintenance/UtilityN IncludeR ReportS SapscriptU User Exit/EnhancementX Temporary, Demo or Test programs

21 of 21

itc abap naming conventions

Documents

appendices b module

appendices c sub module

sap technical development

sap developers

saps naming convention

overall project

program type ids19

following table