Skip to Content
SAP Fiori

OData 4.0 Vocabularies - SAP Common

Tags:

Common terms for all SAP vocabularies

Namespace: com.sap.vocabularies.Common.v1

TermDescription
ServiceVersion1 for first version of a service, incremented when schema changes incompatibly and service is published with a different URI
ServiceSchemaVersion0 for first schema version within a service version, incremented when schema changes compatibly
LabelA short, human-readable text suitable for labels and captions in UIs
HeadingA short, human-readable text suitable for column headings in UIs
QuickInfoA short, human-readable text suitable for tool tips in UIs
TextA descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.
TextFormatHuman-readable text that may contain formatting information
IsDigitSequenceContains only digits
IsUpperCaseContains just uppercase characters
SecondaryKeyThe listed properties form a secondary key. Multiple secondary keys are possible using different qualifiers.
MinOccursThe annotated set or collection contains at least this number of items
MaxOccursThe annotated set or collection contains at most this number of items
AssociationEntityEntity representing an n:m association with attributes
DerivedNavigationShortcut for a multi-segment navigation, contains the long path with all its segments
MaskedProperty contains sensitive data that should by default be masked on a UI and clear-text visible only upon user interaction
SemanticObjectName of the Semantic Object represented as this entity type or identified by this property
IsInstanceAnnotationTerm can also be used as instance annotation; AppliesTo of this term specifies where it can be applied
InsertableSpecifies whether the service allows to create an entity by sending a POST request to the navigation link URL (in this case the created entity is automatically linked to the entity containing the navigation link)
UpdatableSpecifies whether the annotated entity can be updated
DeletableSpecifies whether the annotated entity can be deleted
FilterExpressionRestrictionsThese properties only allow a subset of expressions
FieldControlControl state of a property
IsActionCriticalCriticality of the function or action to enforce a warning or similar before it's executed
AttributesAttributes related to this property, which may occur in denormalized entity types
RelatedRecursiveHierarchyA recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy.
IntervalAn interval with lower and upper boundaries described by two properties
ResultContextThe annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties.
ValueListSpecifies how to get a list of acceptable values for a property or parameter
IsCalendarYearProperty encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})
IsCalendarHalfyearProperty encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2]
IsCalendarQuarterProperty encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4]
IsCalendarMonthProperty encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]|1[0-2]
IsCalendarWeekProperty encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]|[1-4][0-9]|5[2-3]
IsDayOfCalendarMonthDay number relative to a calendar month. Valid values are between 1 and 31.
IsDayOfCalendarYearDay number relative to a calendar year. Valid values are between 1 and 366.
IsCalendarYearHalfyearProperty encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})[1-2]
IsCalendarYearQuarterProperty encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})[1-4]
IsCalendarYearMonthProperty encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|1[0-2])
IsCalendarYearWeekProperty encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|[1-4][0-9]|5[2-3])
IsCalendarDateProperty encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100.
IsFiscalYearProperty encodes a fiscal year number as string following the logical pattern YYYY(Y*) consisting of at least four digits. The string matches the regex pattern [1-9][0-9]{3,}
IsFiscalPeriodProperty encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3}
IsFiscalYearPeriodProperty encodes a fiscal year and period as string following the logical pattern YYYY(Y*)PPP consisting of at least seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3,})([0-9]{3})
IsFiscalYearVariantProperty encodes a fiscal year variant
MutuallyExclusiveTermOnly one term of the group identified with the Qualifier attribute can be applied
DraftRootRoot entities of business documents that support the draft pattern
DraftNodeEntities in this set are parts of business documents that support the draft pattern
DraftActivationViaDraft entities in this set are indirectly activated via draft entities in the referenced entity sets
SemanticKeyThe listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity
SideEffectsChanges to the source properties may have side-effects on the target properties or entities. If neither TargetProperties nor TargetEntities are specified, a change to the source property values may have unforeseeable side-effects. An empty NavigationPropertyPath may be used in TargetEntities to specify that any property of the annotated entity type may be affected. Special case "Actions": here the change trigger is the action invocation, so SourceProperties and SourceEntities have no meaning, only TargetProperties and TargetEntities are relevant. They are addressed via the binding parameter of the action.
DerivedDefaultValueFunction import to derive a default value for the property from a given context.
FilterDefaultValueA default value for the property to be used in filter expressions.
DerivedFilterDefaultValueFunction import to derive a default value for the property from a given context in order to use it in filter expressions.
SortOrderList of sort criteria. The Items of the annotated EntitySet or the Items of the collection of the annotated EntityType are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder Collection, and so on.
RecursiveHierarchyDefines a recursive hierarchy.
CreatedAtCreation timestamp
CreatedByFirst editor
ChangedAtLast modification timestamp
ChangedByLast editor

Vocabulary File

For a complete definition of the terms see the attached document

Common.xml (46470 B)
Common.xml (46397 B)
Common.xml (46834 B)

No comments