Show TOC

Annotations Used in Overview Pages Locate this document in the navigation structure

This topic provides a list of the annotations used in overview pages. They are as follows:

  • com.sap.vocabularies.UI.v1.HeaderInfo
  • com.sap.vocabularies.UI.v1.DataField
  • com.sap.vocabularies.UI.v1.DataFieldForAnnotation
  • com.sap.vocabularies.UI.v1.DataFieldForAction
  • com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation
  • com.sap.vocabularies.UI.v1.DataPoint
  • com.sap.vocabularies.UI.v1.Identification
  • com.sap.vocabularies.UI.v1.LineItem
  • com.sap.vocabularies.UI.v1.Facets
  • com.sap.vocabularies.UI.v1.FieldGroup
  • com.sap.vocabularies.UI.v1.SelectionVariant
  • com.sap.vocabularies.UI.v1.PresentationVariant
  • com.sap.vocabularies.UI.v1.Chart
com.sap.vocabularies.UI.v1.HeaderInfo
The following properties are supported:
  • TypeName
  • TypeNamePlural
  • ImageUrl
  • Title
  • Description
Sample Code 
<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>
com.sap.vocabularies.UI.v1.DataField
DataField is used to display simple text fields. The following properties are supported:
  • Label: the label of the field
  • Value: the value of the field, usually pointing to a path in the metadata
Sample Code 
<Record Type="com.sap.vocabularies.UI.v1.DataField">
    <PropertyValue Property="Label" String="Total Sum"/>
    <PropertyValue Property="Value" Path="TotalSum"/>
</Record>
com.sap.vocabularies.UI.v1.DataFieldForAnnotation
DataFieldForAnnotation can be used to reference a different annotation term, using the Target property. The following properties are supported:
  • Label: the label of the field
  • Target: reference to a different term in the annotation document
Sample Code 
<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>
com.sap.vocabularies.UI.v1.DataFieldForAction
DataFieldForAction is used for OData actions that can be preformed on an entity, and refer to a FunctionImport action definition in the OData metadata. The following properties are supported:
  • Label: the navigation label displayed in the footer of the quick view card.
  • Action: name of the FunctionImport action definition to use
Sample Code 
<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>
com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation
The DataFieldForIntentBasedNavigation record type supports the following properties:
  • SemanticObject: intent semantic object
  • Action: action of the intent
  • Label: the navigation label displayed in the footer of the quick view card
Sample Code 
<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>
com.sap.vocabularies.UI.v1.DataPoint
The DataPoint term is used to display fields with special formatting. The following properties are supported:
  • Title: Used in table cards for the column name
  • Value: Field to display
  • ValueFormat: Used with the NumberFormat annotation to format a decimal value

    • com.sap.vocabularies.UI.v1.NumberFormat:

      • ScaleFactor: Overview pages use standard SAPUI5 formatting, so this value is ignored.
      • NumberOfFractionalDigits: Number of decimal points to display

  • 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: Value is displayed using a neutral color (default).
    • com.sap.vocabularies.UI.v1.CriticalityType/Negative: Vlue is displayed using a color for errors (red).
    • com.sap.vocabularies.UI.v1.CriticalityType/Critical: Value is displayed using a color for critical values (orange).
    • com.sap.vocabularies.UI.v1.CriticalityType/Positive: Value is displayed using a color for positive values (green).

  • com.sap.vocabularies.UI.v1.CriticalityCalculation: Used to color the value dynamically according to the value in the record type com.sap.vocabularies.UI.v1.CriticalityCalculationType. It supports the following values:

    • ImprovementDirection: Defines what is considered a positive value. Possible values are:

      • Minimize: IfMinimize 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 the DeviationRangeHighValue, the value is considered critical and is displayed in orange.
        • If the value is greater than the ToleranceRangeHighValue the value is considered negative and is displayed in red.

      • Target: If Target is the improvement direction, the DeviationRangeLowValue, DeviationRangeHighValue, ToleranceRangeLowValue, and ToleranceRangeHighValue properties are required.

        • If the value is between the ToleranceRangeHighValue and ToleranceRangeLowValue, the value is considered positive and is displayed in green.
        • If the value is between DeviationRangeLowValue and DeviationRangeLowValue, or between DeviationRangeHighValue and ToleranceRangeHighValue, the value is considered critical and is displayed in orange.
        • If the value is lower than the DeviationRangeLowValue or higher than DeviationRangeHighValue, the value is considered negative and is displayed in red.

      • Maximize: If Maximize is the improvement direction, the DeviationRangeLowValue and ToleranceRangeLowValue properties are required.

        • If the value is greater than the ToleranceRangeLowValue, the value is considered positive and is displayed in green.
        • If the value is between ToleranceRangeLowValue and the DeviationRangeLowValue, the value is considered critical and is displayed in orange.
        • If the value is lower than the ToleranceRangeLowValue, the value is considered negative and is displayed in red.
Sample Code 
<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.Identification
This term is used as a container for card actions. The following record types are supported:
  • com.sap.vocabularies.UI.v1.DataFieldForAction
  • com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation
  • com.sap.vocabularies.UI.v1.DataFieldWithUrl
Sample Code 
<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.LineItem
This term is used to display lists of fields in a list or a table. The following record types are supported:
  • com.sap.vocabularies.UI.v1.DataField
  • com.sap.vocabularies.UI.v1.DataFieldForAnnotation
  • com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation
  • com.sap.vocabularies.UI.v1.DataFieldWithUrl
Sample Code 
<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>
com.sap.vocabularies.UI.v1.Facets
The Facets term contains a collection of facets.
Note

Overview pages only support the com.sap.vocabularies.UI.v1.ReferenceFacet record type.

Sample Code 
<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>
com.sap.vocabularies.UI.v1.FieldGroup
This term consists of a label and a collection of com.sap.vocabularies.UI.v1.DataFieldAbstract fields.
Sample Code 
<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>
com.sap.vocabularies.UI.v1.SelectionVariant

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: Name of the selection variant
  • Parameters: Collection of com.sap.vocabularies.UI.v1.ParameterAbstract terms
  • SelectOptions: Collection of com.sap.vocabularies.UI.v1.SelectOptionType terms used to define filters on this entity set
Sample Code 
<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>
com.sap.vocabularies.UI.v1.PresentationVariant
Defines the way in which the result of a queried collection of entities is displayed in the KPI header. The following properties are supported:
  • ID: Can contain an identifier to reference this instance from an external context
  • Text: Name of presentation variant
  • SortOrder: Collection of com.sap.vocabularies.Common.v1.SortOrderType records
  • GroupBy: Collection of PropertyPath properties
Sample Code 
<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>
com.sap.vocabularies.UI.v1.Chart

Defines the dimensions and measures used in charts. The following properties are supported:

  • Title
  • Description
  • ChartType
  • Measures: 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: Collection of PropertyPath properties
  • DimensionAttributes: 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.
Sample Code 
<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>