You are on page 1of 63

© Cielo Solutions. All rights reserved. Proprietary and confidential.

Not to be distributed or reproduced without permission from Cielo Solutions.


APPROVAL AND OWNERSHIP
Prepared by Reviewed by Approved by
Name: Subeesh Kannottil Name: Sooraj manjery Name:

Designation: Senior Consultant Designation: Senior Consultant Designation:

Date: October 05th, 2021 Date: October 10th , 2021 Date:

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Document Review and Approval

Date Name Organization / Title Version Comments

< month dd, <Name> <Organization/Title> <Insert <Comments>


yyyy > version>

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Table of Contents
Contents
1. INTRODUCTION .......................................................................................................... 8
1.1 Coverage .......................................................................................................................................... 8

2. OVERVIEW .................................................................................................................. 9
2.1 Acronym Standard........................................................................................................................... 9
2.1.1 Module Name ........................................................................................................................ 9
2.1.2 Program Type ....................................................................................................................... 9
2.1.3 Substitution Conventions ...................................................................................................... 9
2.1.4 Prefix Usage........................................................................................................................ 10

3. NAMING CONVENTIONS FOR ABAP OBJECTS ...................................................... 11


3.1 Package .......................................................................................................................................... 11

3.2 Business Engineering Objects ..................................................................................................... 11


3.2.1 Methods .............................................................................................................................. 11
3.2.2 Container Elements ............................................................................................................. 12

3.3 Workflow ........................................................................................................................................ 12


3.3.1 Workflow Template Abbreviations ....................................................................................... 12
3.3.2 Standard Task Abbreviations .............................................................................................. 12
3.3.3 Rules Abbreviations ............................................................................................................ 13

3.4 Data Dictionary Objects ................................................................................................................ 13


3.4.1 Database Tables ................................................................................................................. 13
3.4.2 Tables – Index ID ()............................................................................................................. 14
3.4.3 Table Field .......................................................................................................................... 14
3.4.4 Views .................................................................................................................................. 15
3.4.5 Table Types ........................................................................................................................ 15
3.4.6 Structures ............................................................................................................................ 16
3.4.7 Append Structures .............................................................................................................. 16
3.4.8 Data Elements..................................................................................................................... 17
3.4.9 Domain ................................................................................................................................ 18
3.4.10 Search Help ........................................................................................................................ 18
3.4.11 Lock Objects () .................................................................................................................... 19
3.4.12 Type Groups () .................................................................................................................... 19

4. ABAP PROGRAMS .................................................................................................... 20


4.1 Executable Reports and Programs .............................................................................................. 20
4.1.1 Custom Developed ABAP Programs ................................................................................... 20
4.1.2 Duplication of Standard SAP ABAPs .................................................................................. 20
4.1.3 Variants ............................................................................................................................... 21

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
4.2 INCLUDE Program ......................................................................................................................... 21

4.3 Module Pool Programs () .............................................................................................................. 21

4.4 Program data Declaration naming Convention ........................................................................... 22

5. FUNCTIONS .............................................................................................................. 23
5.1 Custom Function Groups ............................................................................................................. 23

5.2 Function Module ............................................................................................................................ 24

6. CLASS LIBRARY ....................................................................................................... 24


6.1 Classes ........................................................................................................................................... 25

6.2 Interfaces ........................................................................................................................................ 26

6.3 General Remarks ........................................................................................................................... 26

6.4 Conventions for Components ...................................................................................................... 28

6.5 Conventions Within Methods for Parameters ............................................................................. 30

7. GATEWAY ................................................................................................................. 31
7.1 Gateway Project ............................................................................................................................. 31

8. FIORI ......................................................................................................................... 32
8.1 8.1. FIORI Apps .............................................................................................................................. 32

9. CDS VIEWS ............................................................................................................... 32


9.1 CDS ................................................................................................................................................. 33

9.2 SQL View ........................................................................................................................................ 33

10. GUI INTERFACE........................................................................................................ 34


10.1 GUI Status ...................................................................................................................................... 34

10.2 GUI Title .......................................................................................................................................... 35

11. TRANSACTION.......................................................................................................... 36
11.1 Dialog Transaction ........................................................................................................................ 36

11.2 Report Transaction ........................................................................................................................ 36

11.3 OO (Class Method) Transaction ................................................................................................... 36

11.4 Variant Transaction ....................................................................................................................... 36

11.5 Parameter Transaction .................................................................................................................. 36

11.6 Custom Transaction Code ............................................................................................................ 37

12. MESSAGES ............................................................................................................... 38

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
12.1 Message Classes ........................................................................................................................... 38

12.2 Message Numbers ......................................................................................................................... 38

13. ABAP QUERIES AND USER GROUPS ..................................................................... 40

14. BDC SESSION ........................................................................................................... 41

15. DATA TRANSFER WORKBENCH – LEGACY SYSTEM MIGRATION WORKBENCH


(LSMW)............................................................................................................................... 42
15.1 LSMW Projects............................................................................................................................... 42

15.2 LSMW Sub-projects ....................................................................................................................... 42

15.3 LSMW Object.................................................................................................................................. 43

16. EVENT ....................................................................................................................... 43

17. FORMS ...................................................................................................................... 44


17.1 ADOBE FORMS .............................................................................................................................. 44
17.1.1 Adobe Form ........................................................................................................................ 44
17.1.2 Adobe Form Interface ......................................................................................................... 44

17.2 SMART FORMS .............................................................................................................................. 45


17.2.1 Smart Form ......................................................................................................................... 45
17.2.2 Smart Style.......................................................................................................................... 46
17.2.3 Text Module ........................................................................................................................ 47

17.3 SAP Script ...................................................................................................................................... 47


17.3.1 Layout Set ........................................................................................................................... 47
17.3.2 Standard Text ID ................................................................................................................. 48
17.3.3 Standard Text Name ........................................................................................................... 48
17.3.4 Styles .................................................................................................................................. 49

18. FIELD EXITS.............................................................................................................. 50


18.1 Field Exits: Definition ................................................................................................................... 50

18.2 Field Exits: Don’ts ........................................................................................................................ 50

19. CUSTOMER ENHANCEMENTS ................................................................................ 50


19.1 Enhancement Projects (????) ...................................................................................................... 50

19.2 Customer Exits .............................................................................................................................. 51

19.3 Business Add-Ins (BAdI) Definition ............................................................................................. 51

19.4 Business Add-Ins (BAdI) Implementations ................................................................................. 52

19.5 Enhancement Spot (via Enhancement Framework) ................................................................... 53

19.6 Composite Enhancement Spot (via Enhancement Framework) ................................................ 54

19.7 Enhancement Point (via Enhancement Framework) .................................................................. 54

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
19.8 Enhancement Implementations (via Enhancement Framework) ............................................... 55

19.9 Composite Enhancement Implementations (via Enhancement Framework) ........................... 56

20. TRANSPORT REQUEST ........................................................................................... 57


20.1 Creation of Transport Request ..................................................................................................... 58

20.2 Releasing of Transport Request................................................................................................... 58

21. AUTHORIZATION ...................................................................................................... 59


21.1 Authorization Class ....................................................................................................................... 59

21.2 Authorization Object ..................................................................................................................... 59

21.3 Authorization Group ...................................................................................................................... 60

22. BATCH JOB ............................................................................................................... 61

23. NAMING CONVENTIONS SUMMARY TABLE ........................................................... 63

24. APPENDIX - NOTABLE OSS NOTES ........................................................................ 63

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
1. Introduction
The naming standards described in this document are for use during the Design and Build Phases of the
Lekhwiya S4Hana Implementation. The aim of these standards is to provide a means by which to easily identify
the function or content of a customised object. These standards should therefore be employed for each object
created or modified.

In the case where a naming standard does not exist for a required object, a standard may be developed and be
included in this document. Likewise, if an existing standard proves insufficient, then this problem should be
raised and resolved with updates reflected in this document.

1.1 Coverage
The naming standards described in this document are to be used for all the developers in the
Build Team.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
2. Overview
2.1 Acronym Standard
The following sections provide the different acronyms that are used throughout this document. In the
subsequent documents where the acronym is referenced, the developer will have to replace it with the actual
value in their custom development objects.

For example, in custom ABAP program , in custom ABAP program is for Human Resource module, the
module name is ‘HR’ .

2.1.1 Module Name


The following naming conventions for the module names are derived from the SAP Application Area for
different SAP applications.

Applications Module Description


HR Human Resources
MM Material Management
PM Plant Maintenance
QM Quality Management
FI Finance
SD Sales and Distribution

2.1.2 Program Type


Type Indicator Description

R Report or Executable Program

I Interface

C Conversion

E Enhancements

F Forms (SAP Script, Smart forms, Adobe forms)

W Workflow

X Extractors for SAP BI

M Others

2.1.3 Substitution Conventions


Values Description

X Any character

N Numeric

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
2.1.4 Prefix Usage
Values Description

Z Use the ‘Z’ prefix for all customized objects developed by the CORE application
development Team.

Y Use for temporary programs developed by the CORE Development Team and is not
meant for production transport

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
3. Naming Conventions for ABAP Objects
The naming conventions defined herein are intended for the function or meaning of an object
to be easily identified from the object’s name. Additionally, for independent objects, they call
for the distinction between SAP's supplied objects and user-defined, customised objects.

Where applicable, the development objects should be given a meaningful title as well as
Short Text (i.e., Documentation).

Ensure that the custom objects are assigned to the appropriate custom package.

3.1 Package
Package is used in the Correction/Transport system. It is used to group all objects that are
related to the same development to ensure they are corrected and transported together.
Each package has an assigned integration system and an assigned consolidation system for
transports.
`
Note: Since Basis 6.xx, the term 'Development Class’ has changed to 'Package'. Therefore, the term
‘Development Class’ can be used interchangeably with the term ‘Package’.

Format: (maximum of 30 characters)


Z XX_ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
Under
| Module Score
Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 30 Descriptive Text Free Text Package name

3.2 Business Engineering Objects


Note: If the new object type is created as a subtype of the SAP object type, the naming convention will
follow the SAP standard object type.

Example: To enhance SAP Object Type INSTLN Utility Installation, then the new object type will
be ZINSTLN (maximum of 10 characters).
3.2.1 Methods
Format: (maximum of 32 characters)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Method Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 – 32 Method Name Free Text Method Name

Example: GetRelatedObjects
Method Name = (GetRelatedObjects) – Related Objects
3.2.2 Container Elements
Format: (maximum of 32 characters)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Container Name

Position Description Values Meaning

1 – 32 Container Name Free Text Element Name

Example: Relationtype
Element Name = (Relationship type) – Relationship type (‘C’, ‘P’, ‘U’)

3.3 Workflow
A workflow definition is made up of individual steps and events with one step and one or more
events making up one unit. These units can be arranged in sequence or in parallel.
3.3.1 Workflow Template Abbreviations
Workflow identification number must begin with WS – Standard Workflow and is followed by numbers
created automatically by the workflow.

Format: (maximum of 12 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| Module Underscore
Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 11 Descriptive Text Free Text Workflow Template Name

3.3.2 Standard Task Abbreviations


Workflow task identification number must begin with TS – Standard Task and is followed by
numbers created automatically by the workflow.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Format: (maximum of 12 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| Module Underscore
Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 12 Descriptive Text Free Text Standard Task Name

3.3.3 Rules Abbreviations


Format: (maximum of 12 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| Module Underscore
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5– 12 Free Text Free Text Rule Name

3.4 Data Dictionary Objects


3.4.1 Database Tables
Format: (maximum of 16 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
| Module Underscore
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 16 Descriptive Text Free Text Table Name

3.4.2 Tables – Index ID ()


Format: (maximum of 3 characters)
Z NN

| |

| Index number

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Index Number 00-99 Unique identifier

3.4.3 Table Field


Note: This section is only applicable while defining append or include structures for standard
SAP table/structure.
User fields must be unique within a table definition.
▪ Where possible, use the same name as the custom data element associated with this
field prefixed by ZZ’. For example, ZZMTP to denote a custom table field has been
added.
▪ Where possible, use an existing SAP data element prefixed by ‘ZZ’.
▪ Do not use spaces or special characters in a table field name.

Format: (maximum of 16 characters)


ZZ XXXXXXXXXXXXXX

| |

| Descriptive Text

Custom Indicator

Position Description Values Meaning

1–2 Custom Indicator ‘ZZ’ Custom Table Field

3 – 16 Descriptive Text Free Text Table Field Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
3.4.4 Views
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.

Format: (maximum of 16 characters)

Z XX _ X XXXXXXXXXXXXXXXX
| | | | |
| | | | Descriptive Text
| | | View Type
| | Underscore
Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–4 Module Name See section 2.1.1 See section 2.1.1

5 Underscore ‘_’ Underscore

6 View Type ‘H’ Help View

‘D’ Database View

‘P’ Projection View

‘M’ Maintenance View

7 – 16 Descriptive Text Free Text View Name

3.4.5 Table Types


A table type describes the structure and functional attributes of an internal table in ABAP.

Format: (maximum of 30 characters)

Z XX _ TT _ XXXXXXXXXXXXXXXX
| | | | | |
| | | | | Descriptive Text
| | | | |
| | | Type |
Indicator
| | Underscore Underscore
| Module
Custom Indicator

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 Custom Indicator ‘Z’ Customised Table Type

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5-6 Type Indicator TT Table Type

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Table Type Name

3.4.6 Structures
Note: The structure name has a maximum length of 30 characters, however, if you want to use the
structure as include in a transparent table at a later time, the component names may not be
longer than 16 characters.

Format: (maximum of 30 characters for include structure)

Z XX _ ST XXXXXXXXXXXXXXXX
| | | | | |
| | | | | Descriptive Text
| Module Underscore | Underscore
Custom Type
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2-3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5-6 Type Indicator ST Structure Type

7 Underscore ‘_’ Underscore

8– 16 Descriptive Text Free Text Structure Name

3.4.7 Append Structures


APPEND Structures can be used to enhance the SAP standard tables.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
An APPEND structure can only be appended to one table as the
structure contains a link to this table. APPEND structures cannot be
appended to pool or cluster tables, for example, table BSEG

Depending on the standard release you are using, you need to check that the
upper limit of fields per table is not exceeded when you add any APPENDs.

Format: (maximum of 30 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| Module Underscore
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 30 Descriptive Text Free Text Append Structure Name

3.4.8 Data Elements


Note: Wherever possible, existing SAP Data Elements should be used.

Format: (maximum of 30 characters)

Z XX _ DE _ XXXXXXXXXXXXXXXX
| | | | | |
| | | | | Descriptive Text
| | Underscore | Undescore
Module Type indicator
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
2-3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5-6 Type Indicator ‘DE’ Data Element

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Data Element name

3.4.9 Domain
Note:
▪ Wherever possible, existing SAP Domains should be used.
▪ As SAP uses all letters of the alphabet, including ‘Y’ and ‘Z’, customised domain must begin
with a ‘Z’ to distinguish them from SAP domains.

Format: (maximum of 30 characters)

Z XX _ DM _ XXXXXXXXXXXXXXXX
| | | | | |
| | | | | Descriptive Text
| | Underscore | Underscore
Module Type indicator
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2-3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5-6 Type indicator ‘DM’ Domain

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Domain name

3.4.10 Search Help


Format: (maximum of 30 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| | Underscore
Module

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2-3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 30 Descriptive Text Free Text Search Help name

3.4.11 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.

Format: (maximum of 16 characters)


EZ XXXXXXXXXXXXX

| |

| Primary Table Name

Custom Indicator

Position Description Values Meaning

1-2 Custom Indicator ‘EZ’ Custom Developed Object

3 – 16 Primary Table Name Free Text The name of the primary table entered
in the primary table field of the Lock
Object create screen

3.4.12 Type Groups ()


Format: (maximum of 5 characters)
Z XX NN

| | |

| | Unique Identifier

| Module Name

Custom Indicator

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Unique Identifier 0-9 Type Group Number

4. ABAP Programs
4.1 Executable Reports and Programs
4.1.1 Custom Developed ABAP Programs
Format: (maximum of 40 characters)

Z XX _ X _ XXXXXXXXXXXXX
| | | | | |
| | | | | Descriptive Text
| | | | Under
score
| | | Program
Type
| | Under
score
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed ABAP Report

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 Program Type See section 2.1.2 See section 2.1.2

6 Underscore ‘_’ Underscore

7 – 40 Descriptive Text Free Text Program Name

4.1.2 Duplication of Standard SAP ABAPs


If a standard ABAP program is to be enhanced, make a copy of the program, saving it as a
new custom program following the naming standards described above.

Example:
RM06EL00 -----> ZRM06EL00

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
4.1.3 Variants
Variants are associated with executable ABAP programs. A program may have multiple
variants. The variant name may be 14 characters long and must be unique for an ABAP
program.

Format: (maximum of 14 characters)


XXXXXXXXXXXXXX

Descriptive Text

Position Description Values Meaning

1 – 14 Descriptive Text Free Text Consistent with the “Unique job


identifier” component of the Batch Job
Name.

4.2 INCLUDE Program


The naming standard used for custom developed INCLUDEs is the same as that for custom
developed executable reports and programs. See Custom Developed ABAPs, with the
following suffixes:
TOP Contains the report name and any data declaration
T00 – TXX Additional data declarations
F00 – FXX Contains all logics and subroutines of the program
4.3 Module Pool Programs ()
Format: (maximum of 40 characters)
Z SAPM XX X XXXXXXXXXXXXXXXXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Program Type

| | Module Name

| Module Pool Prefix

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’’ Custom Developed Object

2–5 SAP Module Pool ‘SAPM’ SAP Default Prefix


Prefix

6–7 Module Name See section 2.1.1 See section 2.1.1

8 Program Type See section 2.1.2 See section 2.1.2

9 – 40 Descriptive Text Free Text Module Pool Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
4.4 Program data Declaration naming Convention

• Global Parameters in Program


TYPES : TY_*

CONSTANTS : GC_*

DATA : GV_*

GS_*

GT_*

GO_*

TT_*

FIELD-SYMBOLS : <FS_*

PARAMETER(S) : P_*

SELECT-OPTIONS : S_*

Table Control : TC_

Global Range : GR_


• Local Parameters in Program
TYPES : TY_*

CONSTANTS : LC_*

DATA : LV_*

LT_*

LS_*

LO_*

TT_*

FIELD-SYMBOLS : <LS_*

Local Range : LR_

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
• Global Classes / Interfaces
CLASS : ZCL_*

INTERFACE : ZIF_*

TYPE : TY_*

CONSTANTS : GC_*

DATA : GV_*
• Local Classes / Interfaces
CLASS : LCL_*

INTERFACE : LIF_*

TYPE : TY_*

CONSTANTS : LC_*

DATA : LV_*
• Method parameters
IMPORTING : IV_*, IT_*, IS_*, IO_*

EXPORTING : EV_*, ET_*, ES_*

CHANGING : CV_*, CT_*, CS_*,

RETURNING : RV_*, RT_*, RS_*,


• Functions
IMPORTING : IV_*, IT_*, IS_*, IO_*

EXPORTING : EV_*, ET_*, ES_*

CHANGING : CV_*, CT_*, CS_*

TABLES : T_*

5. Functions
5.1 Custom Function Groups
Function groups, type F programs, are containers for function modules, and cannot be started by
entering their name directly. Function modules are special procedures that you can call from other
ABAP programs. They can be started by a transaction code if they are constructed with screen flow
support, like module pools , type M programs.

When a Function Group is created, SAP creates a program with the naming convention SAPLxxxx,
where xxxx is the name of the function group.

Format: (maximum of 26 characters)


Z XX _ XXXXXXXXXXXXXXXX

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
| | | |
| | | Descriptive Text
| Module Underscore
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator Z Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 26 Descriptive Text Free Text Function Group name

5.2 Function Module


Format: (maximum of 30 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| Module Underscore
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator Z Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5– 26 Descriptive Text Free Text Function Module name

6. Class Library
Through the Class Builder, a tool within the ABAP Workbench, you may create, define, and test
global ABAP classes and interfaces.

The following naming convention has been defined by SAP for use within the SAP
namespace. If you do not observe the naming conventions for object types (classes
and interfaces), conflicts will occur when the system creates persistent badies, since it
will be unable to generate the necessary co-classes.
Namespace for Components

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
A single namespace within a class is shared by:
• All components of the class itself (attributes, methods, events, constructors, interfaces,
internal data types in the class, and aliases).
• All public and protected components of the super classes of the class.
• Method implementation has a local namespace. The names of the local variables can obscure
those of class components.
Naming Convention

The naming convention has been kept as general as possible to avoid adversely influencing the
naming of objects.

As with other development objects, it is important to maintain a distinction between SAP


objects and Customer objects. Following the standard convention will be used to
maintain this distinction between SAP and customer classes and interfaces. Local
classes and interfaces do not need to follow this convention.

6.1 Classes
Format: (maximum 30 characters)

Z XX _ CL _ XXXXXX
| | | | | |
| | | | | Descriptive
Text
| | | | Underscore
| | | |
| | | |
| | | Class
Indicator
| | Underscore
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Class

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–7 Class Identifier ‘CL’ Class Identifier

8 Underscore ‘_’ Underscore

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
9 – 30 Descriptive Text Free Text Class name

6.2 Interfaces
Format: (maximum 30 characters)

Z XX _ IF _ XXXXXX
| | | | | |
| | | | | Descriptive
Text
| | | | Underscore
| | | |
| | | |
| | | Interface
Indicator
| | Underscore
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Class

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–7 Interface Identifier ‘IF’ Interface Indicator

8 Underscore ‘_’ Underscore

9 – 30 Descriptive Text Free Text Interface name

6.3 General Remarks


When you choose names for development objects, you should:
• Use English names
• Use glossary terms when possible
For example, ZHR_CL_TICKETS
• In compound names, use the underscore character (_) as a separator. Since names are not
case-sensitive, this is the only character that you can use to separate names.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
• Names should describe the action, not the implementation of the action.
Example: PRINT_RECTANGLE, not RECTANGLE_TO_SPOOL

Conventions for Object Types

Class and interface names in the class library belong to the same namespace as data elements,
tables, structures, and types. They are maintained centrally in table TADIR and have a maximum
length of 30 characters.

OBJECT TYPE MEANING

Class in the class library ZHR_CL_<class name>

HR -> module name

Interfaces in the class library ZHR_IF _<interface name>

HR -> Module name.

The same naming convention applies to interfaces as to classes.

ZHR_IF_STATUS_MANAGEMANT

Local classes in programs LCL_<class name>

(recommendation)

The class name should be made up of singular nouns.

LCL_TREE_MANAGEMENT

Local interfaces in programs LIF_<interface name>

(recommendation)

The same naming convention applies to interfaces as to classes.

LIF_PRINTER

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
6.4 Conventions for Components
Components of global classes and interfaces may be used by only one class or, by the defining class
and its subclasses.

COMPONENT MEANING

Method name
<method name>

Method names should begin with a verb:

Local method example: GET_STATUS,

Global method example: CREATE_ORDER


Events
<event name>

Event names should have the form

<noun>_<participle>:

Local event example: BUTTON_PUSHED


Global event example: COMPANY_CODE_CHANGED

Local type definitions within a class TY_<type name>


(recommendation)

TY_INTERNAL_TYPE, TY_TREE_LIST

Data definitions (variables) MV_<variable name>

When you name variables within a class (CLASS-DATA or


DATA), avoid using verbs at the beginning of the name (to
avoid conflicts with method names).

LINE_COUNT, MARK_PRINTED, MARK_CHANGED, STATUS

Data definitions (constants) GC_<constant name>

(recommendation)

GC_MAX_LINE, GC_DEFAULT_STATUS,
GC_DEFAULT_WIDTH, GC_MAX_ROWS

Recommended naming conventions are not compulsory. However, if you use prefixes for these class and
interface names, you should use those listed above.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Concrete Method Descriptions

METHOD DESCRIPTION MEANING

Attribute access SET_<attribute name>, GET_<attribute name>

Methods that access attributes of any kind should be


prefaced with GET_ or SET_.

GET_STATUS (local method)


SET USE_COUNT (global method)

Event handler methods ON_<event name>

Methods that handle events should begin with ON,


followed by the name of the event that they handle.

ON_BUTTON_PUSHED (local method)


ON_BUTTON_PUSHED (global method)

Methods that perform type AS_<new type>


conversions

AS_STRING (local method)


AS_ISOCODE (global method)

Methods that return a Boolean value IS_<adjective>

These methods may not return any IS_OPEN (local method)


exceptions.

IS_OPEN (global method)


Recommendation: Use SPACE and
'X' to represent false and true
respectively.

Check methods CHECK_<objective>

CHECK_AUTHORIZATION (local method)

CHECK_PROCESS_DATE (global method)

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
6.5 Conventions Within Methods for Parameters
Parameters are regarded from the point of view of the method that implements them. As these are not shared
with other classes, no customer specific naming convention is needed.

PARAMETER NAMING CONVENTION


IMPORTING IV_/IS_/IT_/IO_/<parameter name>
EXPORTING EV_/ES_/ET_/EO_/<<parameter name>
CHANGING CV_/CS_/CT_/CO_/<parameter name>
RESULT RV_/RS_/RT_/RO_/<parameter name>

For Exceptions:

The following table contains a series of possible exception names that can also be used generically
(for example, NOT_FOUND could also be used as DATE_NOT_FOUND).

EXCEPTION MEANING
ACTION_NOT_SUPPORTED The requested action or function code is not supported.
CANCELLED If a method uses a dialog to find out what has to be
dome (for example, a list of choices), and the user
chooses "Cancel", you can set this exception.
EXISTING A new object that you want to create already exists in
the database.
FAILED The method could not be executed because of the
current environment.
..._FAILED Part of the method could not be completed because of
the current environment. Example OPEN_FAILED

FOREIGN_LOCK Data is locked by another user.


INCONSISTENT Object data in the database is inconsistent.
..._INCONSISTENT The component data for … of an object in the database
is inconsistent.
INVALID The object data entered is incorrect (for example,
company code does not exist).
..._INVALID The component data entered for an object is incorrect.
Compare NOT_QUALIFIED.
INTERNAL_ERROR Last resort. Only use this exception if you cannot be
more precise about the nature of the error.
NOT_AUTHORIZED The user does not have the required authorization.
NOT_CUSTOMIZED The object requested is not correctly customized.
..._NOT_CUSTOMIZED The component … of the requested object is not
correctly customized.
NOT_FOUND Unable to find the requested object.
..._NOT_FOUND Unable to find component … of the requested object.
NOT_QUALIFIED The combination of input parameters is insufficient to
run the method. Compare INVALID.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
..._NOT_QUALIFIED One parameter of the method is not qualified.
NUMBER_ERROR Error assigning a number.
SYSTEM_ERROR This exception is set if the Basis system returns an
unexpected error message.

7. Gateway
7.1 Gateway Project
Format: (maximum 30 characters)

Z XX _ XXXXXX
| | | |
| | | Descriptive
Text
| | |
| | |
| | |
| | |
| | Underscore
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Class

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 30 Descriptive Text Free Text Interface name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
8. FIORI
8.1 8.1. FIORI Apps
Format: (maximum 15 characters)

Z XX _ XXXXXX
| | | |
| | | Descriptive
Text
| | |
| | |
| | |
| | |
| | Underscore
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Class

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 15 Descriptive Text Free Text Interface name

9. CDS Views
• Use CamelCase naming for CDS View fields (not underscores);
• STOB (name after define view) and DDLS (used in CDS wizard creation wizard) MUST be the
same. CDS STOB views name should start with prefix, for example, ZC_ followed by
CamelCase name (not underscores). CDS DDLS is capitalized by the system;
• CDS View parameter names should be prefixed with P_ followed by by CamelCase name
(not underscores).
• Association names should start with _ followed by view without prefix, for example, _Material
for I_Material.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
9.1 CDS

Z XX X _ XXXXXX
| | | |
| | | Descriptive
Text
| | View Type
| |
| |
| |
| |
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Class

2–3 Module Name See section 2.1.1 See section 2.1.1

4 View Type I – Interface View

C – Consumption
View

5 Underscore ‘_’ Underscore

5 – 30 Descriptive Text Free Text Interface name

9.2 SQL View

Z XX C _ XXXXXX
| | | | |
| | | | Descriptive
Text
| | CDS |
Indicator
| | Underscore
| |
| |
| |
| Module
Custom
Indicator

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Class

2–3 Module Name See section 2.1.1 See section 2.1.1

4 CDS Indicator ‘C’

5 Underscore ‘_’ Underscore

5 – 16 Descriptive Text Free Text Interface name

10. GUI Interface


10.1 GUI Status
A GUI Status is an independent component of an ABAP program, created using the Menu
Painter. The GUI status describes the range of functions available to the user on a screen.
Each function has an associated function code and logic contained in the PROCESS
AFTERINPUT (PAI) or PROCESS ON HELP-REQUEST or PROCESS ON VALUE-
REQUEST modules.
GUI Status names may be up to 20 characters long and must be unique within the program.
Should you have to create a customized GUI Status for a SAP program, prefix the status
name with the ‘Z’ customized indicator.

Note: GUI Status names must be unique within the program. Should you have to create a
customised GUI Status for a SAP program, prefix the status name with the ‘Z’.

Format: (maximum of 20 characters)


Z XXXXXXXXXXXXXXXXXXX

| Descriptive Text

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2 – 20 Descriptive Text Free Text GUI Status Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
10.2 GUI Title
A GUI Title is an independent component of an ABAP program, created using the Menu
Painter. It contains a text line, up to 60 characters long, which is displayed in the window
header line.
GUI Title names may be up to 20 characters long and must be unique within the program.
Should you have to create a customized GUI Title for a SAP program, prefix the title name
with the ‘Z’ customized indicator.
Note: GUI Title names must be unique within the program. Should you have to create a customised
GUI Title for a SAP program, prefix the status name with the ‘Z’.
Format: (maximum of 20 characters)
Z XXXXXXXXXXXXXXXXXXX

| Descriptive Text

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2 – 20 Descriptive Text Free Text GUI Title Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
11. Transaction
A transaction covers a logical process in the system. From the user’s point of view, it
represents a self-contained unit of work.
You can maintain transaction codes using the ABAP Workbench Object Navigator or by
choosing Development → Other tools → Transactions from the SAP Easy Access menu or by
using the Transaction Maintenance transaction (SE93).
When creating a transaction, you must first input the new transaction code and a short text
description for the transaction. Then you must choose the type of transaction from the ‘Start
Object’ list in the Create Transaction Screen (see below for further details).
Each transaction is associated with a development class, which is inherited from the program
called by the transaction.
Additionally, you can protect the transaction against unauthorized use. To do this, enter the
name of an authorization object in the corresponding field.
To enter values for the fields of the authorization object, choose Values.
11.1 Dialog Transaction
In a dialog transaction, the flow of the program is determined by a sequence of screens. For
Dialog Transactions, you will be prompted to provide the program name, initial screen number
and authorization object and values.
11.2 Report Transaction
In a report transaction, you use a transaction code to start an executable program (type 1).
You will be prompted to provide the program name, initial screen number and authorization
object and values. For Report Transactions, the initial screen is the report selection screen.
11.3 OO (Class Method) Transaction
The Class Method transaction is calling a method in the class. This transaction code will
create an instance of the class and call the method in the class. Therefore, you should key in
the Class, Method, Update Mode and Authorization Object.
11.4 Variant Transaction
Transaction variants allow you to present values for fields in a transaction, set field attributes,
or hide entire screens. In the SAP Reference IMG, you can create transaction variants by
choosing Basis Components → Application Personalization → Tailoring of Application
Transactions → Configure Transaction-Related Display Values for Fields (Transaction
SHD0).
To define a variant, enter the name of the transaction and the name of the variant. You can
then use the new transaction code to start the special variant of the transaction.
11.5 Parameter Transaction
Parameter transactions allow you to pre-assign values to fields on the initial screen of a
transaction.
Once you have entered a transaction code and short description, choose transaction type
Transaction with parameters (Parameter transaction).
You can hide the initial screen of a parameter transaction if you have specified values for all
of its fields.

Note: For custom table maintenance, suggest to use the same custom table name as the
custom transaction code.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
11.6 Custom Transaction Code
Format: (maximum of 20 characters)
Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| Module Underscore
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 20 Descriptive Text Free Text Transaction Code

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
12. Messages
Table T100 contains user and system messages that are used during program or report
processing. Transaction SE91 is used to create and maintain these Message Classes and
Messages.
12.1 Message Classes
Format: (maximum of 20 characters)

Z XX _ XXXXXXXXXXXXXXXX

| | | |
| | | Descriptive Text
| | Underscore
| |
| |
| Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Customised Table Type

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 20 Descriptive Text Free Text Message Class Name

12.2 Message Numbers


Format: (maximum of 3 characters)
NNN

Message Number

Position Description Values Meaning

1–3 Message Number 000-999 Message Number

Note:
▪ Each message class will have a generic message, consisting of 4 substitution variables, ‘&’s
only and the message number should be 000. This corresponds to the 4 optional ‘WITH’
parameters of the ABAP MESSAGE statement.
▪ All the custom objects, including enhancements (exits, BAdI, etc) should use a message from
custom message class, so that we can identify the source of the message easily, i.e. message
from SAP standard or from custom object.
▪ Before creating the new message, you should look for an existing message in the system. Only
look for the messages that are relevant for your module. For example, if you are working with

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
an FI program, you should look for messages that are created for FI modules only (this
includes SAP standard message class and custom message class).
▪ If you are working with a message that requires further explanation, you can create a new
message and maintain the long text, so that when the user clicks on the message, the long text
will be displayed.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
13. ABAP Queries and User Groups
ABAP queries are geared towards end-user computing and allow users without any knowledge of the
ABAP programming environment to create and run their own reports. ABAP queries are created and
numbered within User Groups which are associated with Module.

User Groups
User Groups group several similar users together for the purpose of creating and running
ABAP queries. User Groups are named according to the SAP or Customer application area.
Format: (maximum of 12 characters)
Z XXXXXXX

| |

| Descriptive Text

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2 – 11 Descriptive Text Free Text User Group

Queries
Format: (maximum of 14 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| | Underscore
Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 14 Descriptive Text Free Text ABAP Query Description

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
14. BDC Session
Standard:
The naming convention for BDC sessions will vary depending on the needs of a customer. In
many cases, the naming conventions for BDC sessions need to be worked out in conjunction
with the Security Administrator.
Considerations:
• BDC session names do not require unique names.
• BDC security may be set up based on the name of the BDC session.
• A BDC session with a Company Code embedded in the name may be beneficial.
• In many circumstances, end-users will be required to process BDC sessions; this should
be taken into account when establishing BDC naming conventions.

Format: (maximum of 12 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| | Underscore
Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 12 Descriptive Text Free Text BDC Session Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
15. Data Transfer Workbench – Legacy System
Migration Workbench (LSMW)
The preferred method of data conversion and upload into SAP from legacy systems is using LSMW.
Where possible, this tool should be used. In some cases, more sophisticated programming may be
required, and a batch input ABAP may be designed.

The LSMW must be created within a project, sub-project and object. The whole project must
be transported.
15.1 LSMW Projects
Format: (maximum of 15 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| | Underscore
Module
Custom
Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 15 Descriptive Text Free Text LSMW Project Description

15.2 LSMW Sub-projects


Format: (maximum of 15 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| | Underscore
Module
Custom
Indicator

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 15 Descriptive Text Free Text LSMW Sub-project Description

15.3 LSMW Object


Format: (maximum of 15 characters)
XXXX _ XXXXXXXXX

| | |

| | Descriptive Text

Transaction Code

Position Description Values Meaning

1–4 Transaction Code Free Text Transaction Code run by the LSMW

5 Underscore ‘_’ Underscore

6 – 15 Descriptive Text Free Text LSMW Object Description.

If the LSMW updates a single


object, this should be the value of
this field.
If the LSMW updates multiple objects,
this should indicate the action being
performed.

16. Event
Note:
▪ The naming convention for Event is intended for triggering of events as part of online business
processing.
▪ For events used for scheduling of Batch Jobs, the naming convention shall follow that of Batch
Job Names (See Section 25)

Format: (maximum of 32 characters)


Z XXX X XXXXXXXXXXXXXXXXXXXXXXXXXX

| | |

| | Underscore Descriptive Text

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
| Module Name

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–4 Module Name See section 2.1.1 See section 2.1.1

5 Underscore ‘_’ Underscore

6 – 32 Descriptive Text Free Text Event Name

17. Forms
17.1 ADOBE FORMS
17.1.1 Adobe Form
Format: (maximum 30 characters)
Z XX _ AF _ XXXXXXXXXXXXXXXX

| | | | | |

| | | | | Descriptive Text

| | | | Underscore

| | | Form Identifier

| | |

| | Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Form Identifier ‘AF’ Adobe Form Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Adobe form description

17.1.2 Adobe Form Interface


Format: (maximum 30 characters)

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Z XX _ IF _ XXXXXXXXXXXXXXXX

| | | | | |

| | | | | Descriptive Text

| | | | Underscore

| | | Form Identifier

| | |

| |
Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Form Identifier ‘IF’ Adobe Form Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Adobe form description

17.2 SMART FORMS


17.2.1 Smart Form
Format: (maximum 30 characters)

Z XX _ SF _ XXXXXXXXXXXXXXXX

| | | | | |

| | | | | Descriptive Text

| | | | Underscore

| | | Form Identifier

| | Underscore

| |

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Form Identifier ‘SF’ Smart Form Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Smart form description

17.2.2 Smart Style


Each form uses at least one Smart Style. A style is a collection of paragraph and character
formats.

Format: (maximum of 30 characters)

Z XX _ ST _ XXXXXXXXXXXXXXXX

| | | | | |

| | | | | Descriptive Text

| | | | Underscore

| | | Form Identifier

| | Underscore

| |

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Form Identifier ‘ST’ Smart Style Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Smart Style description

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
17.2.3 Text Module
Format: (maximum of 30 characters)
Z XX _ TM _ XXXXXXXXXXXXXXXX

| | | | | |

| | | | | Descriptive Text

| | | | Underscore

| | | Form Identifier

| | Underscore

| |

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Form Identifier ‘TM’ Text Module Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Text Module description

17.3 SAP Script


17.3.1 Layout Set
Format: (maximum of 16 characters)
Z XX _ LS _ XXXXXXXXXXXXXXXX

| | | | | |

| | | | | Descriptive Text

| | | | Underscore

| | | Form Identifier

| | Underscore

| |

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Form Identifier ‘F’ Form

7 Underscore ‘_’ Underscore

8 – 16 Descriptive Text Free Text SAP Script description

17.3.2 Standard Text ID


Format: (maximum of 4 characters)
Z NNN

| |

| Standard Text Number

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–4 Text ID 000-999 Text ID

17.3.3 Standard Text Name


Format: (maximum of 32 characters)

Z XX _ XXXXXXXXXXXXXXXX
| | | |
| | | Descriptive Text
| | Underscore
| |
| |
| Module
Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
5 – 32 Descriptive Text Free Text Standard Text description

17.3.4 Styles
Format: (maximum of 8 characters)
Z XXX

| Descriptive Text

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–8 Descriptive Text Free Text Style Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
18. Field Exits
18.1 Field Exits: Definition
• Field exits must follow the convention: FIELD_EXIT_xxxxx where xxxxx is the name of
the associated data element.
• Each field exit should be assigned to specific programs and screens. Such specific
programs and screen numbers can be derived by getting the technical information of the
screen field (press F1 key on the screen field, then.
• Each field exit application should be specified as a separate function group. Multiple versions of
field exit will follow the standard SAP convention of FIELD_EXIT_xxxxx_1/2/3/4 etc. This enables
each field exit function module to be application specific.
18.2 Field Exits: Don’ts
As of 3.0F, you cannot issue the following commands from a field exit:
• MESSAGE W/I ...... (message E and S are ok)
• CALL SCREEN/DIALOG/TRANSACTION
• SUBMIT
• COMMIT/ROLLBACK WORK
• STOP
• REJECT
• EXIT FROM STEPLOOP
• COMMUNICATION RECEIVE

In addition, field exits cannot be used for check boxes. These are deemed to be graphical elements and
have no input/output status. These values may be accessible in a user exit.

19. Customer Enhancements


SAP has anticipated certain customer requirements for enhancements to the SAP standard
system. These potential enhancements are at pre-planned locations within dialog (screen) or
program logic. They allow the customer to modify predefined, empty or unused programs,
screens or screen function codes.
The SAP application enhancement concept allows you to add your own functionality to SAP
standard business applications via Customer Exits, BAdIs or Enhancement Framework.
19.1 Enhancement Projects (????)
Format: (maximum of 8 characters)
Z XX N

| | |

| | Customer Enhancement No

| Module Name

Custom Indicator

Position Description Values Meaning

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Customer 0-9 Enhancement Project Number


Enhancement No

19.2 Customer Exits


All user exits start with EXIT. The programmer locates the user exit that is applicable and
alters the specified INCLUDE or FUNCTION module. Before a user exit can be activated, an
enhancement project must be specified, it’s associated objects defined and then the project is
activated to implement the exit.
19.3 Business Add-Ins (BAdI) Definition
Format: (maximum of 30 characters)
Z XX _ BADI _ XXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Definition Identifier

| Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–8 Definition Identifier ‘BADI’ BAdI Definition Indicator

9 Underscore ‘_’ Underscore

10– 30 Descriptive Text Free Text BAdI DefinitionName

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
19.4 Business Add-Ins (BAdI) Implementations
Format: (maximum of 20 characters)

Z XX _ BI _ XXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Implementation Identifier

| |

| | Under
score

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5-6 Definition Identifier ‘BI’ BAdI Implementation Indicator

7 Underscore ‘_’ Underscore

8 – 20 Descriptive Text Free Text BAdI Implementation Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
19.5 Enhancement Spot (via Enhancement Framework)
Format: (maximum of 30 characters)

Z XX _ ES _ XXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Enhancement Spot n Identifier

| |

| | Under
score

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–8 Definition Identifier ‘ES’ Enhancement Spot Indicator

9 Underscore ‘_’ Underscore

10 – 30 Descriptive Text Free Text Enhancement Spot Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
19.6 Composite Enhancement Spot (via Enhancement Framework)
Format: XX _ CS _ XXXXXXXXXXXXXXX
(maximum
of 30
characters)
Z

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Enhancement Spot n Identifier

| |

| | Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–7 Definition Identifier ‘CS’ Composite Enhancement Spot


Indicator

8 Underscore ‘_’ Underscore

9 – 30 Descriptive Text Free Text Composite Enhancement Spot Name

19.7 Enhancement Point (via Enhancement Framework)


Format: (maximum of 30 characters)

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Z XX _ EP _ XXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Enhancement Point Identifier

| |

| | Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Definition Identifier ‘EP’ Enhancement Point Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Enhancement Point Name

19.8 Enhancement Implementations (via Enhancement Framework)


Format: (maximum of 30 characters)

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Z XX _ EI _ XXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Enhancement Implementation Identifier

| |

| | Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Definition Identifier ‘EI’ Enhancement Implementation Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Enhancement Implementation Name

19.9 Composite Enhancement Implementations (via Enhancement


Framework)
Format: (maximum of 30 characters)

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Z XX _ CI _ XXXXXXXXXXXXXXX

| | | | |

| | | | Descriptive Text

| | | Underscore

| | Composite Enhancement Implementation Indicator

| |

| | Underscore

Position Description Values Meaning

1 Custom Indicator ‘Z’ Custom Developed Object

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5–6 Definition Identifier ‘CI’ Composite Enhancement


Implementation Indicator

7 Underscore ‘_’ Underscore

8 – 30 Descriptive Text Free Text Composite Enhancement


Implementation Name

20. Transport Request


Format of Transport Request Number: (maximum of 10 characters)
XXX X NNNNNN

| | |

| | Serial Number

| Transport Type

System ID

Position Description Values Meaning

1–3 System ID ‘S4H’ S/4 HANA Main System

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
4 Transport Type ‘K’ Transportable change request

‘C’ Transport of originals

‘T’ Transport of copies

5 – 10 Serial Number 000001 – 999999 Serial Number

Note:
▪ All transport Requests will be automatically generated by the system.
▪ Workbench and Customising Request/Task use the same format and running serial number.

A Transport Request description may be up to 60 characters in length. Further detail can be


put in the long text associated with the request.

For the naming convention on the Transport Request Description, please refer to the documentation on
the Transport Procedure.

20.1 Creation of Transport Request


SAP Team will create transports and release them.
Development objects will be placed in transports in a way that an entire code/work package
can be released and moved to the next environment with the minimum number of transports.
All tasks and objects attached to a transport should have a logical or programmatic link with
the other objects in that transport.

Transport numbers need to be documented in the development object on creation or


modification of that object. When a transport is released, the transport number needs to be
recorded in the relevant CR.

All transports should be assigned to a Project, please refer to the documentation on the Transport
Procedure for details of what Project to use.

20.2 Releasing of Transport Request


Once a development task has reached a state at which it is ready for QA/Testing, the
changes must be released by the Team Leaders.

The developer will release his or her own tasks within a transport request, complete all
documentation in the task, update the CR (if applicable) and inform the respective Team
Leader. The Team Leader will review the transport and release it.

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
21. Authorization
21.1 Authorization Class
Each authorization object must be assigned to an authorization class when it is created. The
authorization class name is up to 4 characters long.

Format: (maximum of 4 characters)


Z NNN

| |

| Numeric Identifier

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ’Z’ Custom Object Identifier

2-4 Numeric Identifier 000 - 999 Running number to identify the


authorization class per Module

21.2 Authorization Object


An authorization object combines up to 10 authorization fields that are checked using the AND
connective. Customized authorization objects are required when applying non-standard authorizations
to SAP functions or applying security to customized functions.

An authorization object can be up to 10 characters long.

Format: (maximum of 10 characters)


Z XX _ XXXXXX

| | | |

| | | Descriptive Identifier

| | Underscore

| Module name

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ’Z’ Custom Object Identifier

2–3 Module Name See section 2.1.1 See section 2.1.1

4 Underscore ‘_’ Underscore

5 – 10 Descriptive Text Free Text Authorization Object Name

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
21.3 Authorization Group

ABAP/4 authorization group is a means of assigning ABAP/4 programs for process protection. The
system checks that a user belongs to an authorization group when:
• Starting or editing a program.
• Maintaining attributes.
• Using other program development utilities

An authorization group name is up to 8 characters long.

Format: (maximum of 8 characters)


Z XX _ NNNN

| | | |

| | | Numeric Identifier

| | Underscore

| Module name

Custom Indicator

Position Description Values Meaning

1 Custom Indicator ’Z’ Custom Object Identifier

2–3 Module Name See section 2.1.1 See section2.1.1

4 Underscore ‘_’ Underscore

5–8 Numeric Identifier 0000 - 9999 Running number to identify the unique

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
22. Batch Job
Batch jobs include programs and reports that are executed as part of a scheduled batch run.
Batch jobs have a maximum of 32 characters, but for this project, only up to 30 characters will be
utilized.

Format: (maximum of 30 characters)


Z X _ XX _ XXX…. _ XX

| | | | | | | |

| | | | | | | Batch Type Code

| | | | | | Underscore

| | | | | Unique Job Identifier

| | | | Underscore

| | | Module

| | Underscore

| Frequency

Custom Identifier

Position Description Values Meaning

1 Custom Identifier ‘Z’ Constant – distinguishes jobs from SAP


standard jobs (certain SAP standard jobs
are required for Basis, Workflow etc.)

2 Frequency ‘D’ Daily

(Schedule) ‘W’ Weekly

‘F’ Fortnightly

‘M’ Monthly

‘Q’ Quarterly

‘Y’ Yearly

‘O’ Other – Special dependencies

‘A’ Ad-hoc – One time

‘C’ Conversions

3 Underscore ‘_’ Underscore

4–5 Module HR, MM, etc SAP module,component (as per SAP
standard classification hierarchy).

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
Refer to Section 2.1.1 for the Module
Name.

6 Underscore ‘_’ Underscore

7 – 26 Unique Job Free Text A description of the job. A maximum of 20


Identifier characters is allowed and spaces should
not be used as these will be suppressed,
use underscores instead (may not start or
end with underscores).

27 Underscore ‘_’ Underscore

28 – 30 Batch Type Code ‘RPT’ Creates a Report

‘BDC’ Generates a BDC Session

‘UPD’ Updates Database

‘EXT’ Extracts Information

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.
23. Naming Conventions Summary Table
NamingConventionsS
ummary

24. Appendix - Notable OSS notes


Note 560889 - Application log: Customer namespace
Note 104010 - Restrictions for development in namespaces
Note 951659 - Condition tables cannot be created in the object namespace
Note 103358 - Namespace restrictions for change document objects

© Cielo Solutions. All rights reserved. Proprietary and confidential.


Not to be distributed or reproduced without permission from Cielo Solutions.

You might also like