Annotation Tags
With annotation tags, you provide semantic information for properties and entity types of an OData service. For example, you define the semantic description of the identification area, or the UI structure by facets. As a prerequisite, the corresponding OData service retrieves data from the back-end system via a search model. You can use the data provided by the OData service in your annotation file.
The following table provides an overview how an extended search model is reflected in an OData service.
Search Model |
OData Service |
|---|---|
Field |
Property of an Entity Type |
Model Response |
Entity Type |
The following table provides an overview how entity types of an OData service are reflected in annotation files with their tags.
OData Service |
Annotation Tag |
|---|---|
Property of an Entity Type |
Property with PropertyValue Annotations Target |
Entity Type |
Annotations Target |
In an annotation file, the following tags are available:
For the identification of the object to be displayed on the UI:
The Annotations Target="‘Entity Type of the OData service’“> references the entity type provided by the OData service.
For the semantic description of the entity types and properties of an Odata service:
<Annotation Term="‘Vocabulary Alias’.HeaderInfo">
Defines the header information, which must be defined for all objects of the corresponding OData service. It shows language-dependent object information.
<Annotation Term="‘Vocabulary Alias’.Identification">
Defines the header information, plus a set of attributes identifying the object.
<Annotation Term="‘Vocabulary Alias’.Badge">
Defines a business card view, with the most important properties and data fields of the object.
<Annotation Term="‘Vocabulary Alias’.LineItem">
Defines detailed information for the object, which can be linked and displayed in a separate screen, as a table. Line items can be sorted, grouped, or filtered.
<Annotation Term="‘Vocabulary Alias’.FieldGroup">
Defines a group of fields belonging together semantically, and references an entity type of the corresponding OData service.
<Annotation Term="‘Vocabulary Alias’.DataPoint">
Defines key figures for the object, which are provided by the corresponding OData service, or any other OData service, that is from an SAP HANA database.
<Annotation Term=“‘Vocabulary Alias’.Importance”EnumType=”Vocabulary Alias.Priority/High”/>
Combined with the Identification, or LineItem term, the Importance term defines whether a field is displayed with priority Low, Medium, or High.
For the definition of a UI area, such as a facet:
<Annotation Term="‘Vocabulary Alias’.Facet">
Defines a segmentation of content for the object. Facets can reference existing terms, such as identification, or line item. The General facet cannot be changed.
For the definition of single fields with their properties:
<Record Type="‘Vocabulary Alias’.DataField">
Defines a label-value pair that refers a property of the OData service used.
<Record Type="‘Vocabulary Alias’.DataFieldWithNavigation">
Defines a label-value pair that refers a property of the OData service used. The definition consists a link to navigate to a new target, based on a navigation property provided by the OData service, or defined in the annotation file.
<Record Type="‘Vocabulary Alias’.DataFieldWithURL">
Defines a label–value pair that refers a property of the OData service used. The definition consists a URL to navigate to a new target, that is a URL.
<PropertyValue Property="Label" String="‘xxx’"/>
Defines that the label of a record is displayed as a string on the UI.
<PropertyValue Property="Value" Path="‘xxx’"/>
Defines that the value is retrieved from a property of the OData service used.