Rules for Naming Object Type Components (SAP Library)

Rules for Naming Object Type Components

The following naming rules apply to each object type component's ID, name and description:

The ID of an object type component must be unique. An ID already allocated to a key field, for example, can no longer be used as an ID for an attribute, a method or an event.

The ID of a object type component has an identifying character. It has a maximum of 20 characters, and should be in English and comprehensible semantically. The ID begins with a letter, which is followed by letters, digits and underscores.

Upper/lower cases are not significant for identification since only upper case is used. Upper case only can therefore be changed easily into upper/lower case. Upper/lower case always improves legibility even within a word.

The ID of an object type component should not repeat the ID of the object type or the object name. The object type ID precedes the object type component ID in a list. The object type ID and object type component ID are separated with a period.

Examples of object type component IDs of the object type Material are:

Key field: Material.Material
Attribute: Material.Industry
Method: Material.Display
Event: Material.Created

Name

This is a short, language-dependent text with a length of 20 characters. The name can be used on screens or dialog boxes to identify a component. Names should be language-dependent translations of the ID of the object type component. Neither the ID of the object type nor the object name should precede the object type component name.

Description

The description is an explanatory, language-dependent text with a length of 80 characters, which can be used in lists of components or for brief documentation.

Key fields

The ID must be an English noun.

If the ID is generated automatically from ABAP Dictionary fields, it should be checked afterwards.

Attributes

The ID must be an English noun. Use the plural for multiline attributes.

If the ID is generated automatically from ABAP Dictionary fields, it should be checked afterwards. Be careful with abbreviations.

Methods

The ID must be an English verb in the basic form. If the method refers to a specific aspect, attribute or part of an object, put this reference in front in the ID.

Method ItemAdd

Events

The ID must be an English verb that describes the status change.