Skip to content

ABAP Keyword Documentation →  ABAP - Dictionary →  ABAP CDS in ABAP Dictionary →  ABAP CDS - Annotations →  ABAP CDS - SAP Annotations →  ABAP CDS - ABAP Annotations 

ABAP CDS - ABAP Annotation Syntax

The following tables summarize the annotation syntax of all ABAP annotations in CDS DDL and CDS DCL in ABAP CDS. Any specified subannotations are shown using chainings. If square brackets [ ] are specified after a name in the column Annotation, this means that the annotation in front of the square brackets is an annotation array. Any enumeration symbols in an annotation are specified in the column Enums. The column Default shows the default values applied to the evaluation when an annotation is specified without a value. The columns Text and MDE indicate whether the annotation values are translatable texts and whether the annotation can be specified in a metadata extension. The API column indicates whether the annotation can be used in CDS entities defined in ABAP for SAP Cloud Platform. The detailed meanings of each ABAP annotation is documented for the corresponding scope in this documentation.

Other versions: 7.31 | 7.40 | 7.54


AbapAnnotation-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
AbapAnnotation.definitionHidden Annotation definition, test annotation or demonstration annotation that cannot be used in production CDS source code Annotation Definition Boolean - true - - -

AbapCatalog-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
AbapCatalog.buffering.numberOfKeyFields Table buffering, number of key fields when buffering generic areas View Integer - 000 - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.buffering.status Table buffering, enables and disables buffering View String(20) #ACTIVE
#NOT_ALLOWED
#SWITCHED_OFF
#SWITCHED_OFF - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.buffering.type Table buffering, defines the buffering type View String(10) #FULL
#GENERIC
#NONE
#SINGLE
#NONE - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.compiler.compareFilter CDS view, specifies how filter conditions are evaluated in path expressions View Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.dbHints[ ].dbSystem Obsolete: Replaced by Consumption.dbHintsCalculatedBy View String(3) #ADA
#ALL
#ASE
#DB2
#DB4
#DB6
#HDB
#INF
#MSS
#ORA
- - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.dbHints[ ].hint Obsolete: Replaced by Consumption.dbHints[ ] View String(1298) - - - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.preserveKey CDS view, specifies the definition of the key fields in the associated database view View Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.sqlViewAppendName CDS view extension, name of the append view View Extension String(16) - - - - RELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.sqlViewName CDS view, name of the database view View String(16) - - - - RELEASED_FOR_KEY_USER_APPSRELEASED_FOR_SAP_CLOUD_PLATFORM
AbapCatalog.viewEnhancementCategory[ ] CDS view, specifies how the view can be extended using CDS view extensions View String(20) #GROUP_BY
#NONE
#PROJECTION_LIST
#UNION
- - - RELEASED_FOR_SAP_CLOUD_PLATFORM

AccessControl-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
AccessControl.authorizationCheck CDS access control, specifies implicit access control Hierarchy
Table Function
View
String(20) #CHECK
#NOT_ALLOWED
#NOT_REQUIRED
#PRIVILEGED_ONLY
#CHECK - - RELEASED_FOR_SAP_CLOUD_PLATFORM

API-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
API.element.releaseState Element annotation, release element Element String(30) #DEPRECATED - - - -
API.element.successor Element annotation, successor of rejected element Element ElementRef - - - - -
API.state[ ] Annotation definition, release annotation Annotation Definition String(40) #NOT_RELEASED
#RELEASED_FOR_KEY_USER_APPS
#RELEASED_FOR_SAP_CLOUD_PLATFORM
- - - -

ClientDependent-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
ClientDependent Specifies client dependency and how clients are handled (obsolete) Table Function
View
Boolean - true - - -

ClientHandling-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
ClientHandling.algorithm Specifies client handling Table Function
View
String(20) #AUTOMATED
#NONE
#SESSION_VARIABLE
- - - RELEASED_FOR_SAP_CLOUD_PLATFORM
ClientHandling.type Specifies client dependency Table Function
View
String(20) #CLIENT_DEPENDENT
#CLIENT_INDEPENDENT
#INHERITED
#INHERITED - - RELEASED_FOR_SAP_CLOUD_PLATFORM

CompatibilityContract-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
CompatibilityContract.c0.allowedChanges.annotation[ ] Modifiability of an annotation in released CDS entities Annotation Definition String(20) #ADD
#ANY
#CUSTOM
#NONE
#REMOVE
- - - -
CompatibilityContract.c0.allowedChanges.value[ ] Modifiability of annotation values in released CDS entities Annotation Definition String(20) #ADD
#ANY
#CUSTOM
#FALSE_TO_TRUE
#NONE
#REMOVE
#TRUE_TO_FALSE
#UPDATE
- - - -
CompatibilityContract.c0.usageAllowed Usability of an annotation in released CDS entities Annotation Definition Boolean - true - - -
CompatibilityContract.c1.allowedChanges.annotation[ ] Modifiability of an annotation in released CDS entities Annotation Definition String(20) #ADD
#ANY
#CUSTOM
#NONE
#REMOVE
- - - -
CompatibilityContract.c1.allowedChanges.value[ ] Modifiability of annotation values in released CDS entities Annotation Definition String(20) #ADD
#ANY
#CUSTOM
#FALSE_TO_TRUE
#NONE
#REMOVE
#TRUE_TO_FALSE
#UPDATE
- - - -
CompatibilityContract.c1.usageAllowed Usability of an annotation in released CDS entities Annotation Definition Boolean - true - - -
CompatibilityContract.c2.allowedChanges.annotation[ ] Modifiability of an annotation in released CDS entities Annotation Definition String(20) #ADD
#ANY
#CUSTOM
#NONE
#REMOVE
- - - -
CompatibilityContract.c2.allowedChanges.value[ ] Modifiability of annotation values in released CDS entities Annotation Definition String(20) #ADD
#ANY
#CUSTOM
#FALSE_TO_TRUE
#NONE
#REMOVE
#TRUE_TO_FALSE
#UPDATE
- - - -
CompatibilityContract.c2.usageAllowed Usability of an annotation in released CDS entities Annotation Definition Boolean - true - - -

DataAging-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
DataAging.noAgingRestriction Data aging on SAP HANA, specifies how old data is handled Table Function
View
Boolean - true - - -

EndUserText-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
EndUserText.heading Texts, implicit annotation for data element header   String(55) - - X - NOT_RELEASED
EndUserText.label Texts, short text connected to translation Access Policy
Element
Entity
View Extension
Parameter
PFCG Mapping
Role
String(60) - - X X RELEASED_FOR_SAP_CLOUD_PLATFORM
EndUserText.quickInfo Texts, tooltip connected to translation Meta Data Extension
Element
Parameter
String(100) - - X X RELEASED_FOR_SAP_CLOUD_PLATFORM

Environment-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
Environment.sql.passValue Defines pass-by-value of host variables in comparisons in ABAP SQL Element Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM
Environment.systemField Environment, assigns an ABAP system field Parameter String(20) #CLIENT
#SYSTEM_DATE
#SYSTEM_LANGUAGE
#SYSTEM_TIME
#USER
- - - RELEASED_FOR_SAP_CLOUD_PLATFORM

LanguageDependency-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
LanguageDependency.maxLength Annotation definition, specifies the translatibility of texts Annotation Definition Integer - - - - -

MappingRole-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
MappingRole Access control, specifies the assignment of a CDS role to users Role Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM

Metadata-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
Metadata.allowExtensions Metadata, specifies extensibility using metadata extensions Entity Boolean - true - - -
Metadata.ignorePropagatedAnnotations Metadata, specifies how propagated annotations are evaluated using the class CL_DD_DDL_ANNOTATION_SERVICE View Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM
Metadata.layer Metadata, specfies layer in CDS metadata extension Meta Data Extension Integer #CORE
#CUSTOMER
#INDUSTRY
#LOCALIZATION
#PARTNER
- - X -

MetadataExtension-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
MetadataExtension.usageAllowed Annotation definition, specifies the distribution of the annotation in CDS metadata extensions Annotation Definition Boolean - true - - -

ObjectModel-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
ObjectModel.usageType.dataClass undocumented Table Function
View
String(30) #CUSTOMIZING
#MASTER
#META
#MIXED
#ORGANIZATIONAL
#TRANSACTIONAL
#MIXED - - -
ObjectModel.usageType.serviceQuality undocumented Table Function
View
String(30) #A
#B
#C
#D
#P
#X
#X - - -
ObjectModel.usageType.sizeCategory undocumented Table Function
View
String(3) #L
#M
#S
#XL
#XXL
#S - - -

Scope[ ]-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
Scope[ ] Annotation definition (defines the range of validity of the annotation) Annotation Definition String(20) #ACCESSPOLICY
#ANNOTATE
#ANNOTATION
#ASPECT
#CUSTOM_ENTITY
#ELEMENT
#ENTITY
#EXTEND_VIEW
#HIERARCHY
#PARAMETER
#PFCG_MAPPING
#ROLE
#SERVICE
#SIMPLE_TYPE
#TABLE_FUNCTION
#VIEW
- - - -

Semantics-Annotations

Annotation Meaning Scope Typ Enums Default Text MDE API
Semantics.amount.currencyCode Currency field Element ElementRef - - - - RELEASED_FOR_SAP_CLOUD_PLATFORM
Semantics.currencyCode Currency key Element Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM
Semantics.quantity.unitOfMeasure Quantity field Element ElementRef - - - - RELEASED_FOR_SAP_CLOUD_PLATFORM
Semantics.unitOfMeasure Unit key Element Boolean - true - - RELEASED_FOR_SAP_CLOUD_PLATFORM