SAP NetWeaver AS ABAP Release 752, ©Copyright 2017 SAP AG. All rights reserved.
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 detailed meanings of each ABAP annotation is documented for the corresponding scope in this documentation.
Note
See also ABAP Annotation Definitions.
AbapAnnotation-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| 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 |
| AbapCatalog.buffering.numberOfKeyFields | Table buffering, number of key fields when buffering generic areas | View | Integer | - | 000 | - | - |
| AbapCatalog.buffering.status | Table buffering, enables and disables buffering | View | String(20) | #ACTIVE #NOT_ALLOWED #SWITCHED_OFF |
#SWITCHED_OFF | - | - |
| AbapCatalog.buffering.type | Table buffering, defines the buffering type | View | String(10) | #FULL #GENERIC #NONE #SINGLE |
#NONE | - | - |
| AbapCatalog.compiler.compareFilter | CDS view, specifies how filter conditions are evaluated in path expressions | View | Boolean | - | true | - | - |
| AbapCatalog.dbHints[ ].dbSystem | CDS view, database hints evaluated by SADL, database system | View | String(3) | #ADA #ALL #ASE #DB2 #DB4 #DB6 #HDB #INF #MSS #ORA |
- | - | - |
| AbapCatalog.dbHints[ ].hint | CDS view, database hints evaluated by SADL, hint | View | String(1298) | - | - | - | - |
| AbapCatalog.preserveKey | CDS view, specifies the definition of the key fields in the associated database view | View | Boolean | - | true | - | - |
| AbapCatalog.sqlViewAppendName | CDS view extension, name of the append view | View Extension | String(16) | - | - | - | - |
| AbapCatalog.sqlViewName | CDS view, name of the database view | View | String(16) | - | - | - | - |
| AbapCatalog.viewEnhancementCategory[ ] | CDS view (specifies how the view can be extended using CDS view extensions) | View | String(20) | #GROUP_BY #NONE #PROJECTION_LIST #UNION |
- | - | - |
AccessControl-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| AccessControl.authorizationCheck | CDS access control (specifies implicit access control) | Table Function View |
String(20) | #CHECK #NOT_ALLOWED #NOT_REQUIRED #PRIVILEGED_ONLY |
#CHECK | - | - |
ClientDependent-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| 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 |
| ClientHandling.algorithm | Specifies client handling | Table Function View |
String(20) | #AUTOMATED #NONE #SESSION_VARIABLE |
- | - | - |
| ClientHandling.type | Specifies client dependency | Table Function View |
String(20) | #CLIENT_DEPENDENT #CLIENT_INDEPENDENT #INHERITED |
#INHERITED | - | - |
DataAging-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| 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 |
| EndUserText.heading | undocumented | String(55) | - | - | X | - | |
| EndUserText.label | Texts, short text connected to translation | Element View Extension Parameter Role Table Function View |
String(60) | - | - | X | X |
| EndUserText.quickInfo | Texts, tooltip connected to translation | Meta Data Extension Element Parameter |
String(100) | - | - | X | X |
Environment-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| Environment.sql.passValue | currently only evaluated by SADL | Element | Boolean | - | true | - | - |
| Environment.systemField | Environment, assigns an ABAP system field | Parameter | String(20) | #CLIENT #SYSTEM_DATE #SYSTEM_LANGUAGE #SYSTEM_TIME #USER |
- | - | - |
LanguageDependency-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| LanguageDependency.maxLength | Annotation definition, specifies the translatibility of texts | Annotation Definition | Integer | - | - | - | - |
MappingRole-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| MappingRole | Access control, specifies the assignment of a CDS role to users | Role | Boolean | - | true | - | - |
Metadata-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| Metadata.allowExtensions | Metadata, controls extensibility via metadata extensions | View | Boolean | - | true | - | - |
| Metadata.ignorePropagatedAnnotations | Metadata (specifies how propagated annotations are evaluated using the class CL_DD_DDL_ANNOTATION_SERVICE) | View | Boolean | - | true | - | - |
| 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 |
| MetadataExtension.usageAllowed | Annotation definition, specifies the distribution of the annotation in CDS metadata extensions | Annotation Definition | Boolean | - | true | - | - |
Scope[ ]-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| Scope[ ] | Annotation definition (defines the range of validity of the annotation) | Annotation Definition | String(20) | #ANNOTATE #ANNOTATION #ELEMENT #EXTEND_VIEW #PARAMETER #ROLE #SIMPLE_TYPE #TABLE_FUNCTION #VIEW |
- | - | - |
Semantics-Annotations
| Annotation | Meaning | Scope | Typ | Enums | Default | Text | MDE |
| Semantics.amount.currencyCode | Currency field | Element | ElementRef | - | - | - | - |
| Semantics.currencyCode | Currency key | Element | Boolean | - | true | - | - |
| Semantics.quantity.unitOfMeasure | Quantity field | Element | ElementRef | - | - | - | - |
| Semantics.unitOfMeasure | Unit key | Element | Boolean | - | true | - | - |