This topic provides a list of the annotations used in overview pages.
TypeName
<Annotation Term="com.sap.vocabularies.UI.v1.HeaderInfo"> <Record> <PropertyValue Property="TypeName" String="Product"/> <PropertyValue Property="TypeNamePlural" String="Products"/> <PropertyValue Property="Title"> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Value" Path="Name"></PropertyValue> </Record> </PropertyValue> <PropertyValue Property="Description"> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Path="Description" Property="Value"/> </Record> </PropertyValue> <PropertyValue Property="ImageUrl" Path="ProductPicUrl"/> </Record> </Annotation>
Label: the label of the field
<Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Total Sum"/> <PropertyValue Property="Value" Path="TotalSum"/> </Record>
Label: the label of the field
<Record Type="com.sap.vocabularies.UI.v1.DataFieldForAnnotation" Qualifier="WeightMeasure"> <PropertyValue Property="Label" String="Weight Measure"/> <PropertyValue Property="Target" AnnotationPath="@com.sap.vocabularies.UI.v1.DataPoint#WeightMeasure"/> </Record>
Label: the navigation label displayed in the footer of the quick view card.
<Record Type="com.sap.vocabularies.UI.v1.DataFieldForAction"> <Annotation Term="com.sap.vocabularies.UI.v1.Importance" EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/Medium" /> <PropertyValue Property="Label" String="Confirm" /> <PropertyValue Property="Action" String="GWSAMPLE_BASIC.GWSAMPLE_BASIC_Entities/SalesOrder_Confirm" /> </Record>
SemanticObject: intent semantic object
<Record Type="com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation"> <PropertyValue Property="SemanticObject" String="SemanticObject1"/> <PropertyValue Property="Action" String="Action1"/> <PropertyValue Property="Label" String="App1"/> <Annotation Term="com.sap.vocabularies.UI.v1.Importance" EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/Medium"/> </Record>
Title: used in table cards for the column name
com.sap.vocabularies.UI.v1.NumberFormat:
ScaleFactor: overview pages use standard SAPUI5 formatting, so this value is ignored
com.sap.vocabularies.UI.v1.Criticality: an enumeration value that can be used to highlight the value with a certain color. The following values are supported:
com.sap.vocabularies.UI.v1.CriticalityType/Neutral: the value is displayed using a neutral color (default)
ImprovementDirection: defines what is considered a positive value, possible values are:
Minimize: if Minimize is the improvement direction, the DeviationRangeHighValue and ToleranceRangeHighValue properties are required.
If the value is less than the ToleranceRangeHighValue, the value is considered positive and is displayed in green
If the value is between the ToleranceRangeHighValue and ToleranceRangeLowValue, the value is considered positive and is displayed in green
<Annotation Term="com.sap.vocabularies.UI.v1.DataPoint" Qualifier="Price"> <Record Type="com.sap.vocabularies.UI.v1.DataPointType"> <PropertyValue Property="Title" String="Unit Price"/> <PropertyValue Property="Description" Path="Name"/> <PropertyValue Property="Value" Path="Price"/> <PropertyValue Property="ValueFormat"> <Record Type="com.sap.vocabularies.UI.v1.NumberFormat"> <PropertyValue Property="ScaleFactor" Decimal="1000"/> <PropertyValue Property="NumberOfFractionalDigits" int="1"/> </Record> </PropertyValue> <PropertyValue Property="CriticalityCalculation"> <Record Type="com.sap.vocabularies.UI.v1.CriticalityCalculationType"> <PropertyValue Property="ImprovementDirection" EnumMember="com.sap.vocabularies.UI.v1.CriticalityCalculationType/Maximize"/> <PropertyValue Property="ToleranceRangeLowValue" Int="50"/> <PropertyValue Property="DeviationRangeLowValue" Int="30"/> </Record> </PropertyValue> </Record> </Annotation>
com.sap.vocabularies.UI.v1.DataFieldForAction
<Annotation Term="com.sap.vocabularies.UI.v1.Identification"> <Collection> <Record Type="com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation"> <PropertyValue Property="SemanticObject" String="Action"/> <PropertyValue Property="Action" String="toappnavsample"/> <PropertyValue Property="Label" String="SO Navigation (M)"/> <Annotation Term="com.sap.vocabularies.UI.v1.Importance" EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/Medium"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Sales Order ID"/> <PropertyValue Property="Value" Path="SalesOrderID"/> </Record> </Collection> </Annotation>
com.sap.vocabularies.UI.v1.DataField
com.sap.vocabularies.UI.v1.DataFieldForAnnotation
com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation
com.sap.vocabularies.UI.v1.DataFieldWithUrl
<Annotation Term="com.sap.vocabularies.UI.v1.LineItem"> <Collection> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Sales Order ID"/> <PropertyValue Property="Value" Path="SalesOrderID"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Customer Name"/> <PropertyValue Property="Value" Path="CustomerName"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Status"/> <PropertyValue Property="Value" Path="Status"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Note"/> <PropertyValue Property="Value" Path="Note"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataFieldForAnnotation" Qualifier="TotalSum"> <PropertyValue Property="Label" String="Total Sum"/> <PropertyValue Property="Target" AnnotationPath="@com.sap.vocabularies.UI.v1.DataPoint#TotalSum"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataFieldForAnnotation" Qualifier="NetSum"> <PropertyValue Property="Label" String="Net Sum"/> <PropertyValue Property="Target" AnnotationPath="@com.sap.vocabularies.UI.v1.DataPoint#NetSum"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataFieldForAnnotation" Qualifier="Tax"> <PropertyValue Property="Label" String="Tax"/> <PropertyValue Property="Target" AnnotationPath="@com.sap.vocabularies.UI.v1.DataPoint#Tax"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation"> <PropertyValue Property="SemanticObject" String="Action"/> <PropertyValue Property="Action" String="toappnavsample2"/> <PropertyValue Property="Label" String="SO Navigation (M)"/> <Annotation Term="com.sap.vocabularies.UI.v1.Importance" EnumMember="com.sap.vocabularies.UI.v1.ImportanceType/Medium"/> </Record> </Collection> </Annotation>
<Annotation Term="com.sap.vocabularies.UI.v1.Facets"> <Collection> <Record Type="com.sap.vocabularies.UI.v1.ReferenceFacet"> <Annotation Term="com.sap.vocabularies.UI.v1.IsSummary"/> <PropertyValue Property="Label" String="Amounts"/> <PropertyValue Property="Target" AnnotationPath="@com.sap.vocabularies.UI.v1.FieldGroup#Amounts"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.ReferenceFacet"> <Annotation Term="com.sap.vocabularies.UI.v1.IsSummary"/> <PropertyValue Property="Label" String="Note1"/> <PropertyValue Property="Target" AnnotationPath="@com.sap.vocabularies.UI.v1.FieldGroup#Status"/> </Record> </Collection> </Annotation>
<Annotation Term="com.sap.vocabularies.UI.v1.FieldGroup" Qualifier="Amounts"> <Record Type="com.sap.vocabularies.UI.v1.FieldGroupType"> <PropertyValue Property="Label" String="Amounts"/> <PropertyValue Property="Data"> <Collection> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Total Sum"/> <PropertyValue Property="Value" Path="TotalSum"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Net Sum"/> <PropertyValue Property="Value" Path="NetSum"/> </Record> <Record Type="com.sap.vocabularies.UI.v1.DataField"> <PropertyValue Property="Label" String="Tax"/> <PropertyValue Property="Value" Path="Tax"/> </Record> </Collection> </PropertyValue> </Record> </Annotation>
This term consists of a combination of parameters and filters that query the annotated entity set. The following properties are supported:
ID: can contain an identifier to reference this instance from an external context
Text: the name of the selection variant
Parameters: a collection of com.sap.vocabularies.UI.v1.ParameterAbstract terms
SelectOptions: a collection of com.sap.vocabularies.UI.v1.SelectOptionType terms used to define filters on this entity set
<Annotation Term="com.sap.vocabularies.UI.v1.SelectionVariant"> <Record> <PropertyValue Property="SelectOptions"> <Collection> <Record> <PropertyValue Property="PropertyName" PropertyPath="TotalSum" /> <PropertyValue Property="Ranges"> <Collection> <Record> <PropertyValue Property="Sign" EnumMember="com.sap.vocabularies.UI.v1.SelectionRangeSignType/I" /> <PropertyValue Property="Option" EnumMember="com.sap.vocabularies.UI.v1.SelectionRangeOptionType/BT" /> <PropertyValue Property="Low" String="0" /> <PropertyValue Property="High" String="8000" /> </Record> </Collection> </PropertyValue> </Record> </Collection> </PropertyValue> </Record> </Annotation>
ID: can contain an identifier to reference this instance from an external context
Text: the name of the presentation variant
SortOrder: a collection of com.sap.vocabularies.Common.v1.SortOrderType records
GroupBy: a collection of PropertyPath properties
<Annotation Term="com.sap.vocabularies.UI.v1.PresentationVariant"> <Record> <PropertyValue Property="GroupBy"> <Collection> <PropertyPath>Status</PropertyPath> </Collection> </PropertyValue> <PropertyValue Property="SortOrder"> <Collection> <Record> <PropertyValue Property="Property" PropertyPath="TotalSum" /> <PropertyValue Property="Descending" Boolean="true" /> </Record> </Collection> </PropertyValue> </Record> </Annotation>
Defines the dimensions and measures used in charts. The following properties are supported:
Title
Description
ChartType
Measures: a collection of PropertyPath properties
MeasureAttributes: a collection of com.sap.vocabularies.UI.v1.ChartMeasureAttributeType records describing attributes for measures. All measures used in this collection must also be part of the Measures property.
Dimensions: a collection of PropertyPath properties
DimensionAttributes: a collection of com.sap.vocabularies.UI.v1.ChartDimensionAttributeType records describing attributes for dimensions. All dimensions used in this collection must also be part of the Dimensions property
<Annotation Term="com.sap.vocabularies.UI.v1.Chart"> <Record Type="com.sap.vocabularies.UI.v1.ChartDefinitionType"> <PropertyValue Property="Title" String="View1" /> <PropertyValue Property="MeasureAttributes"> <Collection> <Record Type="com.sap.vocabularies.UI.v1.ChartMeasureAttributeType"> <PropertyValue Property="Measure" PropertyPath="TotalSum" /> <PropertyValue Property="Role" EnumMember="com.sap.vocabularies.UI.v1.ChartMeasureRoleType/Axis1" /> </Record> </Collection> </PropertyValue> <PropertyValue Property="DimensionAttributes"> <Collection> <Record Type="com.sap.vocabularies.UI.v1.ChartDimensionAttributeType"> <PropertyValue Property="Dimension" PropertyPath="Status" /> <PropertyValue Property="Role" EnumMember="com.sap.vocabularies.UI.v1.ChartDimensionRoleType/Series" /> </Record> </Collection> </PropertyValue> </Record> </Annotation>