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

Common Vocabulary

Namespace: com.sap.vocabularies.Common.v1

Common terms for all SAP vocabularies

Terms

TermTypeDescription
ServiceVersionInt321 for first version of a service, incremented when schema changes incompatibly and service is published with a different URI
ServiceSchemaVersionInt320 for first schema version within a service version, incremented when schema changes compatibly
LabelStringA short, human-readable text suitable for labels and captions in UIs
HeadingStringA short, human-readable text suitable for column headings in UIs
QuickInfoStringA short, human-readable text suitable for tool tips in UIs
TextStringA descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.
TextFormatTextFormatTypeHuman-readable text that may contain formatting information
IsDigitSequenceTagContains only digits
IsUpperCaseTagContains just uppercase characters
SecondaryKey[PropertyPath]The listed properties form a secondary key. Multiple secondary keys are possible using different qualifiers.
MinOccursInt64The annotated set or collection contains at least this number of items
MaxOccursInt64The annotated set or collection contains at most this number of items
AssociationEntity[NavigationPropertyPath]Entity representing an n:m association with attributes
DerivedNavigationNavigationPropertyPathShortcut for a multi-segment navigation, contains the long path with all its segments
MaskedTagProperty contains sensitive data that should by default be masked on a UI and clear-text visible only upon user interaction
SemanticObjectStringName of the Semantic Object represented as this entity type or identified by this property
SemanticObjectMapping[SemanticObjectMappingType]Maps properties of the annotated entity type or sibling properties of the annotated property to properties of the Semantic Object

This allows "renaming" of properties in the current context to match property names of the Semantic Object, e.g. SenderPartyID to PartyID. Only properties explicitly listed in the mapping are renamed, all other properties are available for intent-based navigation with their "local" name.

SemanticObjectUnavailableActions[String]List of actions that are not available in the current state of the instance of the Semantic Object
IsInstanceAnnotationTagTerm can also be used as instance annotation; AppliesTo of this term specifies where it can be applied
InsertableBooleanSpecifies 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)
UpdatableBooleanSpecifies whether the annotated entity can be updated
DeletableBooleanSpecifies whether the annotated entity can be deleted
FilterExpressionRestrictions (Deprecated)[FilterExpressionRestrictionType]Use term Capabilities.FilterRestrictions instead
FieldControlFieldControlTypeControl state of a property

This term can be used for static field control, providing an enumeration member value in $metadata, as well as dynamically, providing a Path expression.
In the dynamic case the property referenced by the Path expression MUST be of type Edm.Byte to accommodate OData V2 services as well as V4 infrastructures that don't support enumeration types.

IsActionCriticalBooleanCriticality of the function or action to enforce a warning or similar before it's executed
Attributes[PropertyPath]Attributes related to this property, which may occur in denormalized entity types
RelatedRecursiveHierarchyAnnotationPathA recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy.
IntervalIntervalTypeAn interval with lower and upper boundaries described by two properties
ResultContextTagThe 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.
ValueListValueListTypeSpecifies how to get a list of acceptable values for a property or parameter

The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists.

ValueListWithFixedValuesTagIf specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
ValueListReferences[URL]A list of URLs of CSDL documents containing value list mappings for this parameter or property
ValueListMappingValueListMappingTypeSpecifies the mapping between data service properties and value list properties

The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers.

IsCalendarYearTagProperty 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})
IsCalendarHalfyearTagProperty encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2]
IsCalendarQuarterTagProperty 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]
IsCalendarMonthTagProperty 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]
IsCalendarWeekTagProperty 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[0-3]
IsDayOfCalendarMonthTagDay number relative to a calendar month. Valid values are between 1 and 31.
IsDayOfCalendarYearTagDay number relative to a calendar year. Valid values are between 1 and 366.
IsCalendarYearHalfyearTagProperty 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]
IsCalendarYearQuarterTagProperty 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]
IsCalendarYearMonthTagProperty 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])
IsCalendarYearWeekTagProperty 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[0-3])
IsCalendarDateTagProperty 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.
IsFiscalYearTagProperty 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,}
IsFiscalPeriodTagProperty encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3}
IsFiscalYearPeriodTagProperty 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})
IsFiscalYearVariantTagProperty encodes a fiscal year variant
MutuallyExclusiveTermTagOnly one term of the group identified with the Qualifier attribute can be applied
DraftRootDraftRootTypeRoot entities of business documents that support the draft pattern
DraftNodeDraftNodeTypeEntities in this set are parts of business documents that support the draft pattern
DraftActivationVia[SimpleIdentifier]Draft entities in this set are indirectly activated via draft entities in the referenced entity sets
SemanticKey[PropertyPath]The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity
SideEffectsSideEffectsTypeDescribes side-effects of modification operations
FilterDefaultValuePrimitiveTypeA default value for the property to be used in filter expressions.
SortOrder[SortOrderType]List of sort criteria

The items of the annotated entity set or the items of the collection of the annotated entity type 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.

RecursiveHierarchyRecursiveHierarchyTypeDefines a recursive hierarchy.
CreatedAtDateTimeOffsetCreation timestamp
CreatedByUserIDFirst editor
ChangedAtDateTimeOffsetLast modification timestamp
ChangedByUserIDLast editor
OriginalProtocolVersionStringOriginal protocol version of a converted (V4) CSDL document, allowed values 2.0 and 3.0

TextFormatType

MemberValueDescription
plain0Plain text, line breaks represented as the character 0x0A
html1Plain text with markup that can validly appear directly within an HTML DIV element

SemanticObjectMappingType

Maps a property of the annotated entity type or a sibling property of the annotated property to a property of the Semantic Object

PropertyTypeDescription
LocalPropertyPropertyPathPath to a local property that provides the value for the Semantic Object property
SemanticObjectPropertyStringName of the Semantic Object property

FilterExpressionRestrictionType

PropertyTypeDescription
PropertyPropertyPath 
AllowedExpressionsFilterExpressionType 

FilterExpressionType

MemberValueDescription
SingleValue0a single 'eq' clause
MultiValue1one or more 'eq' clauses, separated by 'or'
SingleInterval2at most one 'ge' and one 'le' clause, separated by 'and', alternatively a single 'eq' clause

FieldControlType

Control state of a property

MemberValueDescription
Mandatory7Property must have a non-null value
Optional3Property may have a value or be null
ReadOnly1Property value cannot be changed
Inapplicable0Property has no meaning in the current entity state

Example: in a travel expense report the property DestinationCountry is inapplicable if trip type is domestic, and mandatory if trip type is international.

Hidden0Deprecated synonymn for Inapplicable, do not use

To statically hide a property on a UI use UI.Hidden instead

IntervalType

PropertyTypeDescription
LowerBoundaryPropertyPathProperty holding the lower interval boundary
LowerBoundaryIncludedBooleanThe lower boundary value is included in the interval
UpperBoundaryPropertyPathProperty holding the upper interval boundary
UpperBoundaryIncludedBooleanThe upper boundary value is included in the interval

ValueListType

PropertyTypeDescription
LabelStringHeadline for value list, fallback is the label of the property or parameter
CollectionPathStringResource path of an OData collection with possible values, relative to CollectionRoot
CollectionRootStringService root of the value list collection; not specified means local to the document containing the annotation
SearchSupportedBooleanValue list supports the $search query option

The value of the target property is used as the search expression instead of in $filter

PresentationVariantQualifierSimpleIdentifierAlternative representation of a value help, e.g. as a bar chart

Qualifier for annotation with term com.sap.vocabularies.UI.v1.PresentationVariant on the entity set identified via CollectionPath

Parameters[ValueListParameter]Instructions on how to construct the value list request and consume response properties

ValueListMappingType

PropertyTypeDescription
LabelStringHeadline for value list, fallback is the label of the property or parameter
CollectionPathStringResource path of an OData collection with possible values, relative to the document containing the value list mapping
PresentationVariantQualifierSimpleIdentifierAlternative representation of a value help, e.g. as a bar chart

Qualifier for annotation with term com.sap.vocabularies.UI.v1.PresentationVariant on the value list entity set identified via CollectionPath in the ValueListReference annotation

Parameters[ValueListParameter]Instructions on how to construct the value list request and consume response properties

ValueListParameter

Derived Types:

PropertyTypeDescription
ValueListPropertyStringPath to property in response structure. Format is identical to PropertyPath annotations.

ValueListParameterIn: ValueListParameter

PropertyTypeDescription
ValueListPropertyStringPath to property in response structure. Format is identical to PropertyPath annotations.
LocalDataPropertyPropertyPathPath to property that is used to filter/search the value list

ValueListParameterInOut: ValueListParameter

PropertyTypeDescription
ValueListPropertyStringPath to property in response structure. Format is identical to PropertyPath annotations.
LocalDataPropertyPropertyPathPath to property that is used to filter/search the value list or filled from response

ValueListParameterOut: ValueListParameter

PropertyTypeDescription
ValueListPropertyStringPath to property in response structure. Format is identical to PropertyPath annotations.
LocalDataPropertyPropertyPathPath to property that is filled from response

ValueListParameterDisplayOnly: ValueListParameter

Value list property that is not used to fill the edited entity

PropertyTypeDescription
ValueListPropertyStringPath to property in response structure. Format is identical to PropertyPath annotations.

ValueListParameterFilterOnly: ValueListParameter (Deprecated)

Value list property that is used to filter the value list, not connected to the edited entity

PropertyTypeDescription
ValueListPropertyStringPath to property in response structure. Format is identical to PropertyPath annotations.

DraftRootType: DraftNodeType

PropertyTypeDescription
PreparationActionQualifiedNameAction that prepares a draft document for later activation
ValidationFunction (Deprecated)QualifiedNameSeparate validation without side-effects is not useful
ActivationActionQualifiedNameAction that activates a draft document
EditActionQualifiedNameAction that creates an edit draft
NewActionQualifiedNameAction that creates a new draft. It may have overloads that allow referencing other business documents that are used to pre-fill the new draft

New drafts may also be created by POSTing an empty entity without any properties to the entity set.

DraftNodeType

Derived Types:

PropertyTypeDescription
PreparationActionQualifiedNameAction that prepares a draft document for later activation
ValidationFunction (Deprecated)QualifiedNameSeparate validation without side-effects is not useful

SimpleIdentifier

Type: String

The SimpleIdentifier of an OData construct in scope

QualifiedName

Type: String

The QualifiedName of an OData construct in scope

SideEffectsType

Changes to the source properties or source entities 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.

PropertyTypeDescription
SourceProperties[PropertyPath]Changes to the values of one or more of these properties will affect the targets
SourceEntities[NavigationPropertyPath]Changes to one or more of these entities will affect the targets. An empty path means the annotation target.
TargetProperties[PropertyPath]These properties will be affected if the value of one of the sources changes
TargetEntities[NavigationPropertyPath]These entities will be affected if the value of one of the sources changes. An empty path means the annotation target.
EffectTypes (Deprecated)EffectTypeAll side effects are essentially value changes, differentiation not needed. Do not use together with OnPreparation.

EffectType (Deprecated)

Flag MemberValueDescription
ValidationMessage (Deprecated)1Use ValueChange instead
ValueChange2The value of a target changes

This side effect type declares that changes to source properties or entities may impact the values of any, one or multiple target properties or entities. Upon modification preparation logic is performed that determines additional values to be stored in the draft document.

FieldControlChange (Deprecated)4Use ValueChange instead

SortOrderType

PropertyTypeDescription
PropertyPropertyPathSort property
DescendingBooleanSort direction, ascending if not specified otherwise

RecursiveHierarchyType

PropertyTypeDescription
ExternalNodeKeyPropertyPropertyPathProperty holding the external human-readable key identifying the node
NodeDescendantCountPropertyPropertyPathProperty holding the descendant count for a hierarchy node. The descendant count of a node is the number of its descendants in the hierarchy structure of the result considering only those nodes matching any specified $filter and $search. A property holding descendant counts has an integer data type.
NodeDrillStatePropertyPropertyPathProperty holding the drill state of a hierarchy node. The drill state is indicated by one of the following string values: collapsed, expanded, or leaf. For an expanded node, its children are included in the result collection. For a collapsed node, the children are included in the entity set, but they are not part of the result collection. Retrieving them requires a relaxed filter expression or a separate request filtering on the parent node ID with the ID of the collapsed node. A leaf does not have any child in the entity set.

UserID

Type: String

User ID

  • No labels