CDS Annotations

The following tables summarize all SAP annotations of the Data Definition Language (DDL) of ABAP CDS. Every annotation, which contains a reference to a component in the column Evaluation, is a component annotation. This reference defines technical and semantical properties of CDS objects that are required from specific software components such as OData, UI, and Analytics.

Note

If in the column Annotaion a square bracket [ ] is listed after an identifier, the annotation beforehand is an annotation array that belongs to the subsequent element.

AbapCatalog Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
AbapCatalog.buffering.numberOfKeyFields View ABAP
AbapCatalog.buffering.status View ABAP
AbapCatalog.buffering.type View ABAP
AbapCatalog.compiler.compareFilter View ABAP
AbapCatalog.sqlViewAppendName Extend View ABAP
AbapCatalog.sqlViewName View ABAP
AccessControl Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
AccessControl.authorizationCheck Table Function, View _
MappingRole Role _
Analytics Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Analytics.dataCategory Table Function, View _
Analytics.dataExtraction.enabled Table Function, View _
Analytics.hidden Table Function, View _
Analytics.planning.enabled Table Function, View _
Analytics.query Table Function, View _
Analytics.writeBack.className Table Function, View _
AnalyticsDetails Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
AnalyticsDetails.exceptionAggregationSteps[ ].exceptionAggregationBehavior Element _
AnalyticsDetails.exceptionAggregationSteps[ ].exceptionAggregationElements[ ] Element _
AnalyticsDetails.planning.disaggregation Element _
AnalyticsDetails.planning.distribution Element _
AnalyticsDetails.planning.distributionReference Element _
AnalyticsDetails.planning.enabled Element _
AnalyticsDetails.query.axis Element _
AnalyticsDetails.query.decimals Element _
AnalyticsDetails.query.displayHierarchy Element _
AnalyticsDetails.query.formula Element _
AnalyticsDetails.query.hierarchyBinding[ ].type Element _
AnalyticsDetails.query.hierarchyBinding[ ].value Element _
AnalyticsDetails.query.hierarchyBinding[ ].variableSequence Element _
AnalyticsDetails.query.scaling Element _
AnalyticsDetails.query.totals Element _
AnalyticsDetails.query.variableSequence Element _
AnalyticsDetails.resultValueSource Element _
ClientDependent Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
ClientDependent Table Function, View ABAP
Consumption Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Consumption.defaultValue Parameter _
Consumption.derivation.binding[ ].targetElement Element, Parameter _
Consumption.derivation.binding[ ].targetParameter Element, Parameter _
Consumption.derivation.binding[ ].type Element, Parameter _
Consumption.derivation.binding[ ].value Element, Parameter _
Consumption.derivation.derivationFilter Element, Parameter _
Consumption.derivation.lookupEntity Element, Parameter _
Consumption.derivation.procedure Element, Parameter _
Consumption.derivation.resultElement Element, Parameter _
Consumption.filter.defaultValue Element _
Consumption.filter.hidden Element _
Consumption.filter.hierarchyBinding[ ].type Element _
Consumption.filter.hierarchyBinding[ ].value Element _
Consumption.filter.hierarchyBinding[ ].variableSequence Element _
Consumption.filter.mandatory Element _
Consumption.filter.multipleSelections Element _
Consumption.filter.selectionType Element _
Consumption.groupWith Element _
Consumption.hidden Element _
Consumption.labelElement Element, Parameter _
Consumption.quickInfoElement Element, Parameter _
Consumption.semanticObject Element, Parameter, Table Function, View _
Consumption.valueHelp Element, Parameter _
DataAging Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
DataAging.noAgingRestriction Table Function, View ABAP
DefaultAggregation Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
DefaultAggregation Element _
EndUserText Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
EndUserText.label Element, Parameter, Table Function, View ABAP
EndUserText.quickInfo Element, Parameter ABAP
EnterpriseSearch Annotations
Note

These annotations are currently only available for SAP-internal projects and not released for custom projects.

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
EnterpriseSearch.commonAttributes[ ] Element _
EnterpriseSearch.enabled Table Function, View _
EnterpriseSearch.expand Element  
EnterpriseSearch.highlighted.beginTag Element _
EnterpriseSearch.highlighted.enabled Element _
EnterpriseSearch.highlighted.endTag Element _
EnterpriseSearch.presentationMode[ ] Element _
EnterpriseSearch.snippets.beginTag Element _
EnterpriseSearch.snippets.enabled Element _
EnterpriseSearch.snippets.endTag Element _
EnterpriseSearch.usageMode[ ] Element _
Environment Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Environment.systemField Parameter ABAP
Hierarchy Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Hierarchy.parentChild[ ].label Table Function, View _
Hierarchy.parentChild[ ].multipleParents Table Function, View _
Hierarchy.parentChild[ ].name Table Function, View _
Hierarchy.parentChild[ ].orphanedNode.handling Table Function, View _
Hierarchy.parentChild[ ].orphanedNode.stepParentNodeId[ ] Table Function, View _
Hierarchy.parentChild[ ].recurse.child[ ] Table Function, View _
Hierarchy.parentChild[ ].recurse.parent[ ] Table Function, View _
Hierarchy.parentChild[ ].recurseBy Table Function, View _
Hierarchy.parentChild[ ].rootNode.visibility Table Function, View _
Hierarchy.parentChild[ ].siblingsOrder[ ].by Table Function, View _
Hierarchy.parentChild[ ].siblingsOrder[ ].direction Table Function, View _
MappingRole Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
MappingRole Role _
ObjectModel Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
ObjectModel.association.type[ ] Element SADL
ObjectModel.compositionRoot Table Function, View None
ObjectModel.createEnabled Element SADL
ObjectModel.dataCategory Table Function, View ABQL
ObjectModel.deleteEnabled Element SADL
ObjectModel.foreignKey.association Element Analytical Engine, SADL
ObjectModel.mandatory Element BOPF, SADL
ObjectModel.modelCategory Table Function, View None
ObjectModel.readOnly Element BOPF, SADL
ObjectModel.representativeKey Table Function, View Analytical Engine
ObjectModel.semanticKey[ ] Table Function, View UI
ObjectModel.text.association Element Analytical Engine, SADL
ObjectModel.text.element[ ] Element SADL
ObjectModel.updateEnabled Element SADL
ObjectModel.writeActivePersistence Table Function, View None
ObjectModel.writeDraftPersistence Table Function, View None
ObjectModel.writeEnabled Table Function, View BOPF
OData Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
OData.publish Table Function, View SADL
Search Annotations
Note

These annotations are currently only available for SAP-internal projects and not released for custom projects.

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Search.defaultSearchElement Element _
Search.fuzzinessThreshold Element _
Search.ranking Element _
Search.searchable Table Function, View _
Search.termMappingDictionary Element _
Search.termMappingListID Element _
SearchIndex Annotations
Note

These annotations are currently only available for SAP-internal projects and not released for custom projects.

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
SearchIndex.fuzzy.enabled Element _
SearchIndex.fuzzy.mode Element _
SearchIndex.text.async Element _
SearchIndex.text.enabled Element _
SearchIndex.text.name Element _
SearchIndex.text.phraseIndexRatio Element _
SearchIndex.text.storeOriginalContent Element _
SearchIndex.text.textAnalysis.configurationID Element _
SearchIndex.text.textAnalysis.languageDetection[ ] Element _
SearchIndex.text.textAnalysis.languageElement Element _
SearchIndex.text.textAnalysis.mimeType Element _
SearchIndex.text.textAnalysis.mimeTypeElement Element _
SearchIndex.text.textAnalysis.mode Element _
SearchIndex.text.textAnalysis.tokenSeparators Element _
Semantics Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Annotation Scope Evalution Runtime (Engine)
Semantics.address.city Element, Parameter _
Semantics.address.country Element, Parameter _
Semantics.address.label Element, Parameter _
Semantics.address.postBox Element, Parameter _
Semantics.address.region Element, Parameter _
Semantics.address.street Element, Parameter _
Semantics.address.subRegion Element, Parameter _
Semantics.address.type[ ] Element, Parameter _
Semantics.address.zipCode Element, Parameter _
Semantics.amount.currencyCode Element, Parameter ABAP
Semantics.businessDate.at Element, Parameter _
Semantics.businessDate.createdAt Element, Parameter _
Semantics.businessDate.from Element, Parameter _
Semantics.businessDate.lastChangedAt Element, Parameter _
Semantics.businessDate.to Element, Parameter _
Semantics.calendar.dayOfMonth Element, Parameter _
Semantics.calendar.dayOfYear Element, Parameter _
Semantics.calendar.month Element, Parameter _
Semantics.calendar.quarter Element, Parameter _
Semantics.calendar.week Element, Parameter _
Semantics.calendar.year Element, Parameter _
Semantics.calendar.yearMonth Element, Parameter _
Semantics.calendar.yearQuarter Element, Parameter _
Semantics.calendar.yearWeek Element, Parameter _
Semantics.calendarItem.categories Element, Parameter _
Semantics.calendarItem.class Element, Parameter _
Semantics.calendarItem.completed Element, Parameter _
Semantics.calendarItem.contact Element, Parameter _
Semantics.calendarItem.description Element, Parameter _
Semantics.calendarItem.dtEnd Element, Parameter _
Semantics.calendarItem.dtStart Element, Parameter _
Semantics.calendarItem.due Element, Parameter _
Semantics.calendarItem.duration Element, Parameter _
Semantics.calendarItem.fbType Element, Parameter _
Semantics.calendarItem.location Element, Parameter _
Semantics.calendarItem.percentComplete Element, Parameter _
Semantics.calendarItem.priority Element, Parameter _
Semantics.calendarItem.status Element, Parameter _
Semantics.calendarItem.summary Element, Parameter _
Semantics.calendarItem.transparent Element, Parameter _
Semantics.calendarItem.wholeDay Element, Parameter _
Semantics.contact.birthDate Element, Parameter _
Semantics.contact.note Element, Parameter _
Semantics.contact.photo Element, Parameter _
Semantics.contact.type Element, Parameter _
Semantics.currencyCode Element, Parameter ABAP
Semantics.eMail.address Element, Parameter _
Semantics.eMail.bcc Element, Parameter _
Semantics.eMail.body Element, Parameter _
Semantics.eMail.cc Element, Parameter _
Semantics.eMail.from Element, Parameter _
Semantics.eMail.keywords Element, Parameter _
Semantics.eMail.received Element, Parameter _
Semantics.eMail.sender Element, Parameter _
Semantics.eMail.subject Element, Parameter _
Semantics.eMail.to Element, Parameter _
Semantics.eMail.type[ ] Element, Parameter _
Semantics.fiscal.period Element, Parameter _
Semantics.fiscal.year Element, Parameter _
Semantics.fiscal.yearPeriod Element, Parameter _
Semantics.fiscal.yearVariant Element, Parameter _
Semantics.geoLocation.cartoId Element, Parameter _
Semantics.geoLocation.latitude Element, Parameter _
Semantics.geoLocation.longitude Element, Parameter _
Semantics.geoLocation.normalizedName Element, Parameter _
Semantics.language Element, Parameter _
Semantics.mimeType Element, Parameter _
Semantics.name.additionalName Element, Parameter _
Semantics.name.familyName Element, Parameter _
Semantics.name.fullName Element, Parameter _
Semantics.name.givenName Element, Parameter _
Semantics.name.jobTitle Element, Parameter _
Semantics.name.nickName Element, Parameter _
Semantics.name.prefix Element, Parameter _
Semantics.name.suffix Element, Parameter _
Semantics.organization.name Element, Parameter _
Semantics.organization.role Element, Parameter _
Semantics.organization.unit Element, Parameter _
Semantics.quantity.unitOfMeasure Element, Parameter ABAP
Semantics.systemDate.createdAt Element, Parameter _
Semantics.systemDate.lastChangedAt Element, Parameter _
Semantics.telephone.type[ ] Element, Parameter _
Semantics.text Element, Parameter _
Semantics.time Element, Parameter _
Semantics.unitOfMeasure Element, Parameter ABAP
Semantics.url.mimeType Element, Parameter _
Semantics.user.createdBy Element, Parameter _
Semantics.user.id Element, Parameter _
Semantics.user.lastChangedBy Element, Parameter _
Semantics.user.responsible Element, Parameter _
UI Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
Annotation Scope Evalution Runtime (Engine)
UI.badge.headLine.label Table Function, View _
UI.badge.headLine.targetElement Table Function, View _
UI.badge.headLine.type Table Function, View _
UI.badge.headLine.url Table Function, View _
UI.badge.headLine.value Table Function, View _
UI.badge.imageUrl Table Function, View _
UI.badge.mainInfo.label Table Function, View _
UI.badge.mainInfo.targetElement Table Function, View _
UI.badge.mainInfo.type Table Function, View _
UI.badge.mainInfo.url Table Function, View _
UI.badge.mainInfo.value Table Function, View _
UI.badge.secondaryInfo.label Table Function, View _
UI.badge.secondaryInfo.targetElement Table Function, View _
UI.badge.secondaryInfo.type Table Function, View _
UI.badge.secondaryInfo.url Table Function, View _
UI.badge.secondaryInfo.value Table Function, View _
UI.badge.title.label Table Function, View _
UI.badge.title.targetElement Table Function, View _
UI.badge.title.type Table Function, View _
UI.badge.title.url Table Function, View _
UI.badge.title.value Table Function, View _
UI.badge.typeImageUrl Table Function, View _
UI.chart[ ].chartType Table Function, View _
UI.chart[ ].description Table Function, View _
UI.chart[ ].dimensions[ ] Table Function, View _
UI.chart[ ].measures[ ] Table Function, View _
UI.chart[ ].qualifier Table Function, View _
UI.chart[ ].title Table Function, View _
UI.dataPoint.criticality Table Function, View _
UI.dataPoint.criticalityCalculation.deviationRangeHighValue Table Function, View _
UI.dataPoint.criticalityCalculation.deviationRangeHighValueElement Table Function, View _
UI.dataPoint.criticalityCalculation.deviationRangeLowValue Table Function, View _
UI.dataPoint.criticalityCalculation.deviationRangeLowValueElement Table Function, View _
UI.dataPoint.criticalityCalculation.improvementDirection Table Function, View _
UI.dataPoint.criticalityCalculation.toleranceRangeHighValue Table Function, View _
UI.dataPoint.criticalityCalculation.toleranceRangeHighValueElement Table Function, View _
UI.dataPoint.criticalityCalculation.toleranceRangeLowValue Table Function, View _
UI.dataPoint.criticalityCalculation.toleranceRangeLowValueElement Table Function, View _
UI.dataPoint.description Table Function, View _
UI.dataPoint.longDescription Table Function, View _
UI.dataPoint.referencePeriod.description Table Function, View _
UI.dataPoint.referencePeriod.end Table Function, View _
UI.dataPoint.referencePeriod.start Table Function, View _
UI.dataPoint.responsible Table Function, View _
UI.dataPoint.responsibleName Table Function, View _
UI.dataPoint.targetValue Table Function, View _
UI.dataPoint.targetValueElement Table Function, View _
UI.dataPoint.title Table Function, View _
UI.dataPoint.trend Table Function, View _
UI.dataPoint.trendCalculation.downDifference Table Function, View _
UI.dataPoint.trendCalculation.downDifferenceElement Table Function, View _
UI.dataPoint.trendCalculation.isRelativeDifference Table Function, View _
UI.dataPoint.trendCalculation.referenceValue Table Function, View _
UI.dataPoint.trendCalculation.strongDownDifference Table Function, View _
UI.dataPoint.trendCalculation.strongDownDifferenceElement Table Function, View _
UI.dataPoint.trendCalculation.strongUpDifference Table Function, View _
UI.dataPoint.trendCalculation.strongUpDifferenceElement Table Function, View _
UI.dataPoint.trendCalculation.upDifference Table Function, View _
UI.dataPoint.trendCalculation.upDifferenceElement Table Function, View _
UI.dataPoint.valueFormat.numberOfFractionalDigits Table Function, View _
UI.dataPoint.valueFormat.scaleFactor Table Function, View _
UI.fieldGroup[ ].dataAction Table Function, View _
UI.fieldGroup[ ].exclude Table Function, View _
UI.fieldGroup[ ].groupLabel Table Function, View _
UI.fieldGroup[ ].importance Table Function, View _
UI.fieldGroup[ ].label Table Function, View _
UI.fieldGroup[ ].position Table Function, View _
UI.fieldGroup[ ].qualifier Table Function, View _
UI.fieldGroup[ ].semanticObjectAction Table Function, View _
UI.fieldGroup[ ].targetElement Table Function, View _
UI.fieldGroup[ ].type Table Function, View _
UI.fieldGroup[ ].url Table Function, View _
UI.fieldGroup[ ].value Table Function, View _
UI.headerInfo.description.label Table Function, View _
UI.headerInfo.description.targetElement Table Function, View _
UI.headerInfo.description.type Table Function, View _
UI.headerInfo.description.url Table Function, View _
UI.headerInfo.description.value Table Function, View _
UI.headerInfo.imageUrl Table Function, View _
UI.headerInfo.title.label Table Function, View _
UI.headerInfo.title.targetElement Table Function, View _
UI.headerInfo.title.type Table Function, View _
UI.headerInfo.title.url Table Function, View _
UI.headerInfo.title.value Table Function, View _
UI.headerInfo.typeImageUrl Table Function, View _
UI.headerInfo.typeName Table Function, View _
UI.headerInfo.typeNamePlural Table Function, View _
UI.hidden Element _
UI.identification[ ].dataAction Element _
UI.identification[ ].exclude Element _
UI.identification[ ].importance Element _
UI.identification[ ].label Element _
UI.identification[ ].position Element _
UI.identification[ ].semanticObjectAction Element _
UI.identification[ ].targetElement Element _
UI.identification[ ].type Element _
UI.identification[ ].url Element _
UI.identification[ ].value Element _
UI.lineItem[ ].dataAction Element _
UI.lineItem[ ].exclude Element _
UI.lineItem[ ].importance Element _
UI.lineItem[ ].label Element _
UI.lineItem[ ].position Element _
UI.lineItem[ ].qualifier Element _
UI.lineItem[ ].semanticObjectAction Element _
UI.lineItem[ ].targetElement Element _
UI.lineItem[ ].type Element _
UI.lineItem[ ].url Element _
UI.lineItem[ ].value Element _
UI.masked Element _
UI.multiLineText Element _
UI.selectionField[ ].element Element _
UI.selectionField[ ].exclude Element _
UI.selectionField[ ].position Element _
UI.selectionField[ ].qualifier Element _
VDM Annotations

Description of the specific usage in different frameworks:

Annotation Scope Evalution Runtime (Engine)
VDM.private Table Function, View ABAP
VDM.viewType Table Function, View None