Registration

Dear SAP Community Member,
In order to fully benefit from what the SAP Community has to offer, please register at:
http://scn.sap.com
Thank you,
The SAP Community team.
Skip to end of metadata
Go to start of metadata

UI Vocabulary

Namespace: com.sap.vocabularies.UI.v1

Terms for presenting data in user interfaces

The SAP UI Vocabulary aims to optimize usage of data in UI channels. It focuses on usage patterns of data in UIs, not on UI patterns, and it is completely independent of the UI technologies or devices used to visualize the data.

These usage patterns represent certain semantic views on business data, some of them very general, others centering around the concept of a Thing, i.e. something tangible to end users. Examples for Things are semantic object instances or business object instances. One example for a usage pattern is the collection of properties which helps the user to identify a Thing, the UI.Identification term. Another example is the UI.LineItem term, which is a set of properties suitable for visualizing a collection of business object instances, e.g. as a list or table.

Terms

TermTypeDescription
HeaderInfoHeaderInfoTypeInformation for the header area of an entity representation. HeaderInfo is mandatory for main entity types of the model
Identification[DataFieldAbstract]Collection of fields identifying the object
BadgeBadgeTypeInformation usually displayed in the form of a business card
LineItem[DataFieldAbstract]Collection of data fields for representation in a table or list
StatusInfo[DataFieldAbstract]Collection of data fields describing the status of an entity
FieldGroupFieldGroupTypeGroup of fields with an optional label
ConnectedFieldsConnectedFieldsTypeGroup of semantically connected fields with a representation template and an optional label (Example)
GeoLocations[GeoLocationType]Collection of geographic locations
GeoLocationGeoLocationTypeGeographic location
Contacts[AnnotationPath]Collection of contacts

Each collection item MUST reference an annotation of a Communication.Contact

MediaResourceMediaResourceTypeProperties that describe a media resource
DataPointDataPointTypeVisualization of a single point of data, typically a number; may also be textual, e.g. a status value
KPIKPITypeA Key Performance Indicator (KPI) bundles a SelectionVariant and a DataPoint, and provides details for progressive disclosure
ChartChartDefinitionTypeVisualization of multiple data points
ValueCriticality (Experimental)[ValueCriticalityType]Assign criticalities to primitive values. This information can be used for semantic coloring.
CriticalityLabels (Experimental)[CriticalityLabelType]Assign labels to criticalities. This information can be used for semantic coloring. When applied to a property, a label for a criticality must be provided, if more than one value of the annotated property has been assigned to the same criticality. There must be no more than one label per criticality.
SelectionFields[PropertyPath]Properties that might be relevant for filtering a collection of entities of this type
Facets[Facet]Collection of facets
HeaderFacets[Facet]Facets for additional object header information
QuickViewFacets[Facet]Facets that may be used for a quick overview of the object
QuickCreateFacets[Facet]Facets that may be used for a (quick) create of the object
FilterFacets[ReferenceFacet]Facets that reference UI.FieldGroup annotations to group filterable fields
SelectionPresentationVariantSelectionPresentationVariantTypeA SelectionPresentationVariant bundles a Selection Variant and a Presentation Variant
PresentationVariantPresentationVariantTypeDefines how the result of a queried collection of entities is shaped and how this result is displayed
SelectionVariantSelectionVariantTypeA SelectionVariant denotes a combination of parameters and filters to query the annotated entity set
ThingPerspectiveTagThe annotated term is a Thing Perspective
IsSummaryTagThis Facet and all included Facets are the summary of the thing. At most one Facet of a thing can be tagged with this term
PartOfPreviewTagThis Facet and all included Facets are part of the Thing preview
MapTagTarget MUST reference a UI.GeoLocation, Communication.Address or a collection of these
GalleryTagTarget MUST reference a UI.MediaResource
IsImageURLTagProperties and terms annotated with this term MUST contain a valid URL referencing an resource with a MIME type image
MultiLineTextTagProperties annotated with this annotation should be rendered as multi-line text (e.g. text area)
TextArrangementTextArrangementTypeDescribes the arrangement of a code or ID value and its text

If used for a single property the Common.Text annotation is annotated

ImportanceImportanceTypeExpresses the importance of e.g. a DataField or an annotation
HiddenTagProperties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.

Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature.

CreateHidden (Experimental)TagEntitySets annotated with this term can control the visibility of the Create operation dynamically

The annotation value should be a path to another property from the same or an associated EntitySet.

UpdateHidden (Experimental)TagEntitySets annotated with this term can control the visibility of the Edit/Save operation dynamically

The annotation value should be a path to another property from the same or an associated EntitySet.

DeleteHidden (Experimental)TagEntitySets annotated with this term can control the visibility of the Delete operation dynamically

The annotation value should be a path to another property from the same or an associated EntitySet.

HiddenFilterTagProperties annotated with this term will not be rendered as filter criteria if the annotation evaluates to true.

Properties annotated with HiddenFilter are intended as parts of a $filter expression that cannot be directly influenced by end users. The properties will be rendered in all other places, e.g. table columns or form fields. This is in contrast to properties annotated with Hidden that are not rendered at all.

DataFieldDefaultDataFieldAbstractDefault representation of a property as a datafield, e.g. when the property is added as a table column or form field via personalization

Only concrete subtypes of DataFieldAbstract can be used for a DataFieldDefault. For type DataField and its subtypes the annotation target SHOULD be the same property that is referenced via a path expression in the Value of the datafield.

CriticalityCriticalityTypeService-calculated criticality, alternative to UI.CriticalityCalculation
CriticalityCalculationCriticalityCalculationTypeParameters for client-calculated criticality, alternative to UI.Criticality
OrderBy (Experimental)PropertyPathSort by the referenced property instead of by the annotated property

Example: annotated property SizeCode has string values XS, S, M, L, XL, referenced property SizeOrder has numeric values -2, -1, 0, 1, 2. Numeric ordering by SizeOrder will be more understandable than lexicographic ordering by SizeCode.

RecommendationState (Experimental)RecommendationStateTypeIndicates whether a field contains or has a recommended value

Intelligent systems can help users by recommending input the user may "prefer".

RecommendationList (Experimental)RecommendationListTypeSpecifies how to get a list of recommended values for a property or parameter

Intelligent systems can help users by recommending input the user may "prefer".

ApplyMultiUnitBehaviorForSortingAndFiltering (Experimental)TagSorting and filtering of amounts in multiple currencies needs special consideration

TODO: add link to UX documentation on https://experience.sap.com/fiori-design/

ExcludeFromNavigationContextTagThe contents of this property must not be propagated to the app-to-app navigation context

HeaderInfoType

PropertyTypeDescription
TypeNameStringName of the main entity type
TypeNamePluralStringPlural form of the name of the main entity type
TitleDataFieldAbstractTitle, e.g. for overview pages

This can be a DataField and any of its children, or a DataFieldForAnnotation targeting ConnectedFields.

DescriptionDataFieldAbstractDescription, e.g. for overview pages

This can be a DataField and any of its children, or a DataFieldForAnnotation targeting ConnectedFields.

ImageUrlURLImage URL for an instance of the entity type. If the property ImageUrl has a valid value, it can be used for the visualization of the instance. If it is not available or not valid the property TypeImageUrl can be used instead.
TypeImageUrlURLImage URL for the entity type
Initials (Experimental)StringLatin letters to be used in case no ImageUrl or TypeImageUrl is present

BadgeType

PropertyTypeDescription
HeadLineDataFieldHeadline
TitleDataFieldTitle
ImageUrlURLImage URL for an instance of the entity type. If the property ImageUrl has a valid value, it can be used for the visualization of the instance. If it is not available or not valid the property TypeImageUrl can be used instead.
TypeImageUrlURLImage URL for the entity type
MainInfoDataFieldMain information on the business card
SecondaryInfoDataFieldAdditional information on the business card

FieldGroupType

PropertyTypeDescription
LabelStringLabel for the field group
Data[DataFieldAbstract]Collection of data fields

ConnectedFieldsType

Group of semantically connected fields with a representation template and an optional label

PropertyTypeDescription
LabelStringLabel for the connected fields
TemplateStringTemplate for representing the connected fields

Template variables are identifiers enclosed in curly braces, e.g. {MaterialName} - {MaterialClassName}. The Data collection assigns values to the template variables.

DataDictionaryDictionary of template variables

Each template variable used in Template must be assigned a value here. The value must be of type DataFieldAbstract

GeoLocationType

Properties that define a geographic location

PropertyTypeDescription
LatitudeDoubleGeographic latitude
LongitudeDoubleGeographic longitude
LocationGeographyPointA point in a round-earth coordinate system
AddressAddressTypevCard-style address

MediaResourceType

PropertyTypeDescription
UrlURLURL of media resource
ContentTypeMediaTypeContent type, such as application/pdf, video/x-flv, image/jpeg
ByteSizeInt64Resource size in bytes
ChangedAtDateTimeOffsetDate of last change
ThumbnailImageTypeThumbnail image
TitleDataFieldResource title
DescriptionDataFieldResource description

ImageType

PropertyTypeDescription
UrlURLURL of image
WidthStringWidth of image
HeightStringHeight of image

DataPointType

PropertyTypeDescription
TitleStringTitle of the data point
DescriptionStringShort description
LongDescriptionStringFull description
ValuePrimitiveTypeNumeric value

The value is typically provided via a Path construct. The path MUST lead to a direct property of the same entity type or a property of a complex property (recursively) of that entity type, navigation segments are not allowed.
It could be annotated with either UoM.ISOCurrency or UoM.Unit. Percentage values are annotated with UoM.Unit = '%'. A renderer should take an optional Common.Text annotation into consideration.

TargetValuePrimitiveTypeTarget value
ForecastValuePrimitiveTypeForecast value
MinimumValueDecimalMinimum value (for output rendering)
MaximumValueDecimalMaximum value (for output rendering)
ValueFormatNumberFormatNumber format
VisualizationVisualizationTypePreferred visualization
SampleSizePrimitiveTypeSample size used for the determination of the data point; should contain just integer value as Edm.Byte, Edm.SByte, Edm.Intxx, and Edm.Decimal with scale 0.
ReferencePeriodReferencePeriodReference period
CriticalityCriticalityTypeService-calculated criticality, alternative to CriticalityCalculation
CriticalityLabelsAnnotationPathCustom labels for the criticality legend. Annotation path MUST end in UI.CriticalityLabels
CriticalityRepresentation (Experimental)CriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
CriticalityCalculationCriticalityCalculationTypeParameters for client-calculated criticality, alternative to Criticality
TrendTrendTypeService-calculated trend, alternative to TrendCalculation
TrendCalculationTrendCalculationTypeParameters for client-calculated trend, alternative to Trend
ResponsibleContactTypeContact person

NumberFormat

Describes how to visualise a number

PropertyTypeDescription
ScaleFactorDecimalDisplay value in ScaleFactor units, e.g. 1000 for k (kilo), 1e6 for M (Mega)
NumberOfFractionalDigitsByteNumber of fractional digits of the scaled value to be visualized

VisualizationType

MemberValueDescription
Number0Visualize as a number
BulletChart1Visualize as bullet chart - requires TargetValue
Progress2Visualize as progress indicator - requires TargetValue
Rating3Visualize as partially or completely filled stars/hearts/... - requires TargetValue
Donut4Visualize as donut, optionally with missing segment - requires TargetValue
DeltaBulletChart5Visualize as delta bullet chart - requires TargetValue

ReferencePeriod

Reference period

PropertyTypeDescription
DescriptionStringShort description of the reference period
StartDateTimeOffsetStart of the reference period
EndDateTimeOffsetEnd of the reference period

CriticalityType

Criticality of a value or status, represented e.g. via semantic colors (https://experience.sap.com/fiori-design-web/foundation/colors/#semantic-colors)

MemberValueDescription
VeryNegative (Experimental)-1Very negative / dark-red status - risk - out of stock - late
Neutral0Neutral / grey status - inactive - open - in progress
Negative1Negative / red status - attention - overload - alert
Critical2Critical / orange status - warning
Positive3Positive / green status - completed - available - on track - acceptable
VeryPositive (Experimental)4Very positive / blue status - above max stock - excess

CriticalityCalculationType: CriticalityThresholdsType

Describes how to calculate the criticality of a value depending on the improvement direction

The calculation is done by comparing a value to the threshold values relevant for the specified improvement direction.

The value to be compared is

  • Value - if ReferenceValue is not specified
  • Value sub ReferenceValue – if ReferenceValue is specified and IsRelativeDifference is not specified or specified as false
  • (Value sub ReferenceValue) divBy ReferenceValue – if ReferenceValue is specified and IsRelativeDifference is specified as true

For improvement direction Target, the criticality is calculated using both low and high threshold values. It will be

  • Positive if the value is greater than or equal to AcceptanceRangeLowValue and lower than or equal to AcceptanceRangeHighValue
  • Neutral if the value is greater than or equal to ToleranceRangeLowValue and lower than AcceptanceRangeLowValue OR greater than AcceptanceRangeHighValue and lower than or equal to ToleranceRangeHighValue
  • Critical if the value is greater than or equal to DeviationRangeLowValue and lower than ToleranceRangeLowValue OR greater than ToleranceRangeHighValue and lower than or equal to DeviationRangeHighValue
  • Negative if the value is lower than DeviationRangeLowValue or greater than DeviationRangeHighValue

For improvement direction Minimize, the criticality is calculated using the high threshold values. It is

  • Positive if the value is lower than or equal to AcceptanceRangeHighValue
  • Neutral if the value is greater than AcceptanceRangeHighValue and lower than or equal to ToleranceRangeHighValue
  • Critical if the value is greater than ToleranceRangeHighValue and lower than or equal to DeviationRangeHighValue
  • Negative if the value is greater than DeviationRangeHighValue

For improvement direction Maximize, the criticality is calculated using the low threshold values. It is

  • Positive if the value is greater than or equal to AcceptanceRangeLowValue
  • Neutral if the value is less than AcceptanceRangeLowValue and greater than or equal to ToleranceRangeLowValue
  • Critical if the value is lower than ToleranceRangeLowValue and greater than or equal to DeviationRangeLowValue
  • Negative if the value is lower than DeviationRangeLowValue

Thresholds are optional. For unassigned values, defaults are determined in this order:

  • For DeviationRange, an omitted LowValue translates into the smallest possible number (-INF), an omitted HighValue translates into the largest possible number (+INF)
  • For ToleranceRange, an omitted LowValue will be initialized with DeviationRangeLowValue, an omitted HighValue will be initialized with DeviationRangeHighValue
  • For AcceptanceRange, an omitted LowValue will be initialized with ToleranceRangeLowValue, an omitted HighValue will be initialized with ToleranceRangeHighValue
PropertyTypeDescription
AcceptanceRangeLowValuePrimitiveTypeLowest value that is considered positive
AcceptanceRangeHighValuePrimitiveTypeHighest value that is considered positive
ToleranceRangeLowValuePrimitiveTypeLowest value that is considered neutral
ToleranceRangeHighValuePrimitiveTypeHighest value that is considered neutral
DeviationRangeLowValuePrimitiveTypeLowest value that is considered critical
DeviationRangeHighValuePrimitiveTypeHighest value that is considered critical
ReferenceValue (Experimental)PrimitiveTypeReference value for the calculation, e.g. number of sales for the last year
IsRelativeDifference (Experimental)BooleanCalculate with a relative difference
ImprovementDirectionImprovementDirectionTypeDescribes in which direction the value improves
ConstantThresholds (Experimental)[LevelThresholdsType]List of thresholds depending on the aggregation level as a set of constant values

Constant thresholds shall only be used in order to refine constant values given for the data point overall (aggregation level with empty collection of property paths), but not if the thresholds are based on other measure elements.

CriticalityThresholdsType

Thresholds for calculating the criticality of a value

Derived Types:

PropertyTypeDescription
AcceptanceRangeLowValuePrimitiveTypeLowest value that is considered positive
AcceptanceRangeHighValuePrimitiveTypeHighest value that is considered positive
ToleranceRangeLowValuePrimitiveTypeLowest value that is considered neutral
ToleranceRangeHighValuePrimitiveTypeHighest value that is considered neutral
DeviationRangeLowValuePrimitiveTypeLowest value that is considered critical
DeviationRangeHighValuePrimitiveTypeHighest value that is considered critical

ImprovementDirectionType

Describes which direction of a value change is seen as an improvement

MemberValueDescription
Minimize1Lower is better
Target2Closer to the target is better
Maximize3Higher is better

LevelThresholdsType: CriticalityThresholdsType (Experimental)

Thresholds for an aggregation level

PropertyTypeDescription
AcceptanceRangeLowValuePrimitiveTypeLowest value that is considered positive
AcceptanceRangeHighValuePrimitiveTypeHighest value that is considered positive
ToleranceRangeLowValuePrimitiveTypeLowest value that is considered neutral
ToleranceRangeHighValuePrimitiveTypeHighest value that is considered neutral
DeviationRangeLowValuePrimitiveTypeLowest value that is considered critical
DeviationRangeHighValuePrimitiveTypeHighest value that is considered critical
AggregationLevel[PropertyPath]An unordered tuple of dimensions, i.e. properties which are intended to be used for grouping in aggregating requests. In analytical UIs, e.g. an analytical chart, the aggregation level typically corresponds to the visible dimensions.

TrendType

The trend of a value

MemberValueDescription
StrongUp1Value grows strongly
Up2Value grows
Sideways3Value does not significantly grow or shrink
Down4Value shrinks
StrongDown5Value shrinks strongly

TrendCalculationType

Describes how to calculate the trend of a value

By default, the calculation is done by comparing the difference between Value and ReferenceValue to the threshold values. If IsRelativeDifference is set, the difference of Value and ReferenceValue is divided by ReferenceValue and the relative difference is compared.

The trend is

  • StrongUp if the difference is greater than or equal to StrongUpDifference
  • Up if the difference is less than StrongUpDifference and greater than or equal to UpDifference
  • Sideways if the difference is less than UpDifference and greater than DownDifference
  • Down if the difference is greater than StrongDownDifference and lower than or equal to DownDifference
  • StrongDown if the difference is lower than or equal to StrongDownDifference
PropertyTypeDescription
ReferenceValuePrimitiveTypeReference value for the calculation, e.g. number of sales for the last year
IsRelativeDifferenceBooleanCalculate with a relative difference
UpDifferenceDecimalThreshold for Up
StrongUpDifferenceDecimalThreshold for StrongUp
DownDifferenceDecimalThreshold for Down
StrongDownDifferenceDecimalThreshold for StrongDown

KPIType

PropertyTypeDescription
IDStringOptional identifier to reference this instance from an external context
ShortDescription (Experimental)StringVery short description
SelectionVariantSelectionVariantTypeSelection variant, either specified inline or referencing another annotation via Path
DataPointDataPointTypeData point, either specified inline or referencing another annotation via Path
AdditionalDataPoints[DataPointType]Additional data points, either specified inline or referencing another annotation via Path

Additional data points are typically related to the main data point and provide complementing information or could be used for comparisons

DetailKPIDetailTypeContains information about KPI details, especially drill-down presentations

KPIDetailType

PropertyTypeDescription
DefaultPresentationVariantPresentationVariantTypePresentation variant, either specified inline or referencing another annotation via Path
AlternativePresentationVariants[PresentationVariantType]A list of alternative presentation variants, either specified inline or referencing another annotation via Path
SemanticObjectStringName of the Semantic Object. If not specified, use Semantic Object annotated at the property referenced in KPI/DataPoint/Value
ActionStringName of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger.

ChartDefinitionType

PropertyTypeDescription
TitleStringTitle of the chart
DescriptionStringShort description
ChartTypeChartTypeChart type
AxisScalingChartAxisScalingTypeDescribes the scale of the chart value axes
Measures[PropertyPath]Measures of the chart, e.g. size and color in a bubble chart
MeasureAttributes[ChartMeasureAttributeType]Describes Attributes for Measures. All Measures used in this collection must also be part of the Measures Property.
Dimensions[PropertyPath]Dimensions of the chart, e.g. x- and y-axis of a bubble chart
DimensionAttributes[ChartDimensionAttributeType]Describes Attributes for Dimensions. All Dimensions used in this collection must also be part of the Dimensions Property.
Actions[DataFieldForActionAbstract]Available actions

ChartType

MemberValueDescription
Column0 
ColumnStacked1 
ColumnDual2 
ColumnStackedDual3 
ColumnStacked1004 
ColumnStackedDual1005 
Bar6 
BarStacked7 
BarDual8 
BarStackedDual9 
BarStacked10010 
BarStackedDual10011 
Area12 
AreaStacked13 
AreaStacked10014 
HorizontalArea15 
HorizontalAreaStacked16 
HorizontalAreaStacked10017 
Line18 
LineDual19 
Combination20 
CombinationStacked21 
CombinationDual22 
CombinationStackedDual23 
HorizontalCombinationStacked24 
Pie25 
Donut26 
Scatter27 
Bubble28 
Radar29 
HeatMap30 
TreeMap31 
Waterfall32 
Bullet33 
VerticalBullet34 
HorizontalWaterfall35 
HorizontalCombinationDual36 
HorizontalCombinationStackedDual37 
Donut100 (Experimental)38 

ChartAxisScalingType

PropertyTypeDescription
ScaleBehaviorChartAxisScaleBehaviorTypeScale is fixed or adapts automatically to rendered values
AutoScaleBehaviorChartAxisAutoScaleBehaviorTypeSettings for automatic scaling
FixedScaleMultipleStackedMeasuresBoundaryValuesFixedScaleMultipleStackedMeasuresBoundaryValuesTypeBoundary values for fixed scaling of a stacking chart type with multiple measures

ChartAxisScaleBehaviorType

MemberValueDescription
AutoScale0Value axes scale automatically
FixedScale1Fixed minimum and maximum values are applied, which are derived from the @UI.MeasureAttributes.DataPoint/MinimumValue and .../MaximumValue annotation by default. For stacking chart types with multiple measures, they are taken from ChartAxisScalingType/FixedScaleMultipleStackedMeasuresBoundaryValues.

ChartAxisAutoScaleBehaviorType

PropertyTypeDescription
ZeroAlwaysVisibleBooleanForces the value axis to always display the zero value
DataScopeChartAxisAutoScaleDataScopeTypeDetermines the automatic scaling

ChartAxisAutoScaleDataScopeType

MemberValueDescription
DataSet0Minimum and maximum axes values are determined from the entire data set
VisibleData1Minimum and maximum axes values are determined from the currently visible data. Scrolling will change the scale.

FixedScaleMultipleStackedMeasuresBoundaryValuesType

PropertyTypeDescription
MinimumValueDecimalMinimum value on value axes
MaximumValueDecimalMaximum value on value axes

ChartDimensionAttributeType

PropertyTypeDescription
DimensionPropertyPath 
RoleChartDimensionRoleType 
HierarchyLevel (Experimental)Int32For a dimension with a hierarchy, members are selected from this level. The root node of the hierarchy is at level 0.
ValuesForSequentialColorLevels (Experimental)[String]All values in this collection should be assigned to levels of the same color.
EmphasizedValues (Experimental)[String]All values in this collection should be emphasized.
EmphasisLabels (Experimental)EmphasisLabelTypeAssign a label to values with an emphasized representation. This is required, if more than one emphasized value has been specified.

ChartMeasureAttributeType

PropertyTypeDescription
MeasurePropertyPath 
RoleChartMeasureRoleType 
DataPointAnnotationPathAnnotation path MUST end in @UI.DataPoint and the data point's Value MUST be the same property as in Measure
UseSequentialColorLevels (Experimental)BooleanAll measures for which this setting is true should be assigned to levels of the same color.

ChartDimensionRoleType

MemberValueDescription
Category0 
Series1 
Category22 

ChartMeasureRoleType

MemberValueDescription
Axis10 
Axis21 
Axis32 

EmphasisLabelType (Experimental)

Assigns a label to the set of emphasized values and optionally also for non-emphasized values. This information can be used for semantic coloring.

PropertyTypeDescription
EmphasizedValuesLabelString 
NonEmphasizedValuesLabelString 

ValueCriticalityType (Experimental)

Assigns a fixed criticality to a primitive value. This information can be used for semantic coloring.

PropertyTypeDescription
ValuePrimitiveTypeMUST be a fixed value of primitive type
CriticalityCriticalityType 

CriticalityLabelType (Experimental)

Assigns a label to a criticality. This information can be used for semantic coloring.

PropertyTypeDescription
CriticalityCriticalityType 
LabelStringCriticality label

Facet

Abstract base type for facets

Derived Types:

PropertyTypeDescription
LabelStringFacet label
IDStringUnique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged.

CollectionFacet: Facet

Collection of facets

PropertyTypeDescription
LabelStringFacet label
IDStringUnique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged.
Facets[Facet]Nested facets. An empty collection may be used as a placeholder for content added via extension points.

ReferenceFacet: Facet

Facet that refers to a thing perspective, e.g. LineItem

PropertyTypeDescription
LabelStringFacet label
IDStringUnique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged.
TargetAnnotationPathReferenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge

ReferenceURLFacet: Facet

Facet that refers to a URL

PropertyTypeDescription
LabelStringFacet label
IDStringUnique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged.
UrlURLURL of referenced information
UrlContentTypeMediaTypeMedia type of referenced information

SelectionPresentationVariantType

PropertyTypeDescription
IDStringOptional identifier to reference this variant from an external context
TextStringName of the bundling variant
SelectionVariantSelectionVariantTypeSelection variant, either specified inline or referencing another annotation via Path
PresentationVariantPresentationVariantTypePresentation variant, either specified inline or referencing another annotation via Path

PresentationVariantType

PropertyTypeDescription
IDStringOptional identifier to reference this variant from an external context
TextStringName of the presentation variant
MaxItemsInt32Maximum number of items that should be included in the result
SortOrder[SortOrderType]Collection can be provided inline or as a reference to a Common.SortOrder annotation via Path
GroupBy[PropertyPath]Sequence of groupable properties p1, p2, ... defining how the result is composed of instances representing groups, one for each combination of value properties in the queried collection. The sequence specifies a certain level of aggregation for the queried collection, and every group instance will provide aggregated values for properties that are aggregatable. Moreover, the series of sub-sequences (p1), (p1, p2), ... forms a leveled hierarchy, which may become relevant in combination with InitialExpansionLevel.
TotalBy[PropertyPath]Sub-sequence q1, q2, ... of properties p1, p2, ... specified in GroupBy. With this, additional levels of aggregation are requested in addition to the most granular level defined by GroupBy: Every element in the series of sub-sequences (q1), (q1, q2), ... introduces an additional aggregation level included in the result.
Total[PropertyPath]Aggregatable properties for which aggregated values should be provided for the additional aggregation levels specified in TotalBy.
IncludeGrandTotalBooleanResult should include a grand total for the properties specified in Total
InitialExpansionLevelInt32Level up to which the hierarchy defined for the queried collection should be expanded initially. The hierarchy may be implicitly imposed by the sequence of the GroupBy, or by an explicit hierarchy annotation.
Visualizations[AnnotationPath]Lists available visualization types. Currently supported types are UI.LineItem, UI.Chart, and UI.DataPoint. For each type, no more than a single annotation is meaningful. Multiple instances of the same visualization type shall be modeled with different presentation variants. A reference to UI.Lineitem should always be part of the collection (least common denominator for renderers). The first entry of the collection is the default visualization.
RequestAtLeast[PropertyPath]Properties that should always be included in the result of the queried collection
SelectionFields (Experimental)[PropertyPath]Properties that should be presented for filtering a collection of entities. Can be provided inline or as a reference to a UI.SelectionFields annotation via Path.

SelectionVariantType

PropertyTypeDescription
IDStringMay contain identifier to reference this instance from an external context
TextStringName of the selection variant
Parameters[ParameterAbstract]Parameters of the selection variant
FilterExpressionStringFilter string for query part of URL, without $filter=
SelectOptions[SelectOptionType]ABAP Select Options Pattern

ParameterAbstract

Key property of a parameter entity type

Derived Types:

Parameter: ParameterAbstract

Single-valued parameter

PropertyTypeDescription
PropertyNamePropertyPathPath to a key property of a parameter entity type
PropertyValuePrimitiveTypeValue for the key property

IntervalParameter: ParameterAbstract

Interval parameter formed with a 'from' and a 'to' property

PropertyTypeDescription
PropertyNameFromPropertyPathPath to the 'from' property of a parameter entity type
PropertyValueFromPrimitiveTypeValue for the 'from' property
PropertyNameToPropertyPathPath to the 'to' property of a parameter entity type
PropertyValueToPrimitiveTypeValue for the 'to' property

SelectOptionType

List of value ranges for a single property

PropertyTypeDescription
PropertyNamePropertyPathPath to the property
Ranges[SelectionRangeType]List of value ranges

SelectionRangeType

Value range. If the range option only requires a single value, the value must be in the property Low

PropertyTypeDescription
SignSelectionRangeSignTypeInclude or exclude values
OptionSelectionRangeOptionTypeComparison operator
LowPrimitiveTypeSingle value or lower interval boundary
HighPrimitiveTypeUpper interval boundary

SelectionRangeSignType

MemberValueDescription
I0Inclusive
E1Exclusive

SelectionRangeOptionType

Comparison operator

MemberValueDescription
EQ0Equal to
BT1Between
CP2Contains pattern
LE3Less than or equal to
GE4Greater than or equal to
NE5Not equal to
NB6Not between
NP7Does not contain pattern
GT8Greater than
LT9Less than

TextArrangementType

MemberValueDescription
TextFirst0Text is first, followed by the code/ID (e.g. in parentheses)
TextLast1Code/ID is first, followed by the text (e.g. separated by a dash)
TextSeparate2Code/ID and text are represented separately
TextOnly3Only text is represented, code/ID is hidden (e.g. for UUIDs)

ImportanceType

MemberValueDescription
High0High importance
Medium1Medium importance
Low2Low importance

DataFieldAbstract

Elementary building block that represents a piece of data and/or allows triggering an action

Derived Types:

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon

CriticalityRepresentationType

MemberValueDescription
WithIcon0Criticality is represented with an icon
WithoutIcon1Criticality is represented without icon, e.g. only via text color

DataFieldForAnnotation: DataFieldAbstract

A structured piece of data described by an annotation

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
TargetAnnotationPathTarget MUST reference an annotation of terms Communication.Contact, Communication.Address, UI.DataPoint, UI.Chart, UI.FieldGroup, or UI.ConnectedFields

DataFieldForActionAbstract: DataFieldAbstract

Triggers an action

Derived Types:

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
InlineBooleanAction should be placed close to (or even inside) the visualized term
DeterminingBooleanDetermines whether the action completes a process step (e.g. approve, reject).

DataFieldForAction: DataFieldForActionAbstract

Triggers an OData action

The action is NOT tied to a data value (in contrast to DataFieldWithAction).

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
InlineBooleanAction should be placed close to (or even inside) the visualized term
DeterminingBooleanDetermines whether the action completes a process step (e.g. approve, reject).
ActionQualifiedNameQualified name of an Action, Function, ActionImport or FunctionImport in scope
InvocationGroupingOperationGroupingTypeExpresses how invocations of this action on multiple instances should be grouped

OperationGroupingType

MemberValueDescription
Isolated0Invoke each action in isolation from other actions
ChangeSet1Group all actions into a single change set

DataFieldForIntentBasedNavigation: DataFieldForActionAbstract

Triggers intent-based UI navigation

The navigation intent is is expressed as a Semantic Object and optionally an Action on that object.

It is NOT tied to a data value (in contrast to DataFieldWithIntentBasedNavigation)."

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
InlineBooleanAction should be placed close to (or even inside) the visualized term
DeterminingBooleanDetermines whether the action completes a process step (e.g. approve, reject).
SemanticObjectStringName of the Semantic Object
ActionStringName of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger.
RequiresContextBooleanDetermines whether a context needs to be passed to the target of this navigation.

DataField: DataFieldAbstract

A piece of data

Derived Types:

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
ValuePrimitiveTypeThe data field's value

DataFieldWithAction: DataField

A piece of data that allows triggering an OData action

The action is tied to a data value which should be rendered as a hyperlink. This is in contrast to DataFieldForAction) which is not tied to a specific data value.

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
ValuePrimitiveTypeThe data field's value
ActionQualifiedNameQualified name of an Action, Function, ActionImport or FunctionImport in scope

DataFieldWithIntentBasedNavigation: DataField

A piece of data that allows triggering intent-based UI navigation

The navigation intent is is expressed as a Semantic Object and optionally an Action on that object.

It is tied to a data value which should be rendered as a hyperlink. This is in contrast to DataFieldForIntentBasedNavigation which is not tied to a specific data value.

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
ValuePrimitiveTypeThe data field's value
SemanticObjectStringName of the Semantic Object
ActionStringName of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger.

DataFieldWithNavigationPath: DataField

A piece of data that allows navigating to related data

It should be rendered as a hyperlink

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
ValuePrimitiveTypeThe data field's value
TargetNavigationPropertyPathContains either a navigation property or a term cast, where term is of type Edm.EntityType or a concrete entity type or a collection of these types

DataFieldWithUrl: DataField

A piece of data that allows navigating to other information on the Web

It should be rendered as a hyperlink

PropertyTypeDescription
LabelStringA short, human-readable text suitable for labels and captions in UIs
CriticalityCriticalityTypeCriticality of the data field value
CriticalityRepresentationCriticalityRepresentationTypeDecides if criticality is visualized in addition by means of an icon
IconUrlURLOptional icon
ValuePrimitiveTypeThe data field's value
UrlURLTarget of the hyperlink
UrlContentTypeMediaTypeMedia type of the hyperlink target, e.g. video/mp4

RecommendationStateType (Experimental)

Type: Byte

Indicates whether a field contains or has a recommended value

Editable fields for which a recommendation has been pre-filled or that have recommendations that differ from existing human input need to be highlighted.

Allowed ValueDescription
0regular - with human or default input, no recommendation
1highlighted - without human input and with recommendation
2warning - with human or default input and with recommendation

RecommendationListType (Experimental)

Reference to a recommendation list

A recommendation consists of one or more values for editable fields plus a rank between 0.0 and 9.9, with 9.9 being the best recommendation.

PropertyTypeDescription
CollectionPathStringResource path of a collection of recommended values
RankPropertyStringName of the property within the collection of recommended values that describes the rank of the recommendation
Binding[RecommendationBinding]List of pairs of a local property and recommended value property

RecommendationBinding (Experimental)

PropertyTypeDescription
LocalDataPropertyPropertyPathPath to editable property for which recommended values exist
ValueListPropertyStringPath to property in the collection of recommended values. Format is identical to PropertyPath annotations.

 

  • No labels