User interfaces based on Core Data Services
CDS-View UI annotations are a central concept in SAP development projects for designing user interfaces based on Core Data Services (CDS). They enable the modeling of UI-relevant information directly in the data models and thus form the basis for automatic UI generation in SAP Fiori Elements.
A typical example of the use of UI annotations is the definition of list reports or object pages in Fiori Elements. Here, specific annotations such as @UI.lineItem for tables, @UI.fieldGroup for form fields or @UI.selectionField for filter fields are used to describe the structure and behavior of the UI directly in the CDS views.
You can find all UI annotations is an overview on the website of SAP SE
The most relevant CDS-View annotations
There an lots of CDS-View annotations. Here are the most relevant – in our opinion:
| Annotations | Description | Scope of application |
|---|---|---|
| @UI.lineItem | Defines columns in tables, in list reports e.g. | Table view |
| @UI.selectionField | Highlights fields which should be shown in the filter bar. | Filter bar |
| @UI.identification | Defines fields that are displayed on detail pages, e.g. in the “General information” section. | Detail page |
| @UI.fieldGroup | Groups fields into logical units, e.g. for form sections. | Forms |
| @UI.headerInfo | Defines title and description in the header area of a detail page | Detail page |
| @UI.chart | Describes charts, including type, dimensions and key figures. | Diagrams |
| @UI.dataPoint | Visualizes individual values, e.g. with status displays or trend information. | Key figure displays |
| @UI.statusInfo | Displays status information, e.g. with colors or icons | Status displays |
| @UI.hidden | Controls the visibility of fields in the UI. | In general |
| @UI.importance | Specifies the importance of an element (e.g. HIGH, MEDIUM, LOW), which can influence the display on different devices. | Responsive design |
| @UI.semanticObject | Links a field with a semantic object to enable navigation. | Navigation |
Do you have any questions?
Get in touch with us.