From 7df21f8bcec67ac8173c03aa3de9b31263e9a53b Mon Sep 17 00:00:00 2001 From: D024504 Date: Mon, 6 Dec 2021 11:45:24 +0100 Subject: [PATCH 1/8] Common.Locale annotation --- vocabularies/Common.json | 11 ++ vocabularies/Common.md | 391 ++++++++++++++++++++------------------- vocabularies/Common.xml | 11 ++ 3 files changed, 218 insertions(+), 195 deletions(-) diff --git a/vocabularies/Common.json b/vocabularies/Common.json index 6675e77d..1258508f 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -158,6 +158,17 @@ "@Core.LongDescription": "Time zones shall be specified according to the [IANA](https://www.iana.org/time-zones) standard.\n If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone.", "@Core.RequiresType": "Edm.DateTimeOffset" }, + "Locale": { + "$Kind": "Term", + "$Nullable": true, + "$AppliesTo": [ + "Property", + "Parameter" + ], + "@Common.Experimental": true, + "@Core.Description": "The value of the annotated property or parameter shall be interpreted in the given locale", + "@Core.LongDescription": "Locales shall be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers).\nIf this annotation is absent or null, the current user's or default locale is used.\n\nAn example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent." + }, "IsDigitSequence": { "$Kind": "Term", "$Type": "Core.Tag", diff --git a/vocabularies/Common.md b/vocabularies/Common.md index eb3dea41..3506c970 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -20,95 +20,96 @@ Term|Type|Description [IsLanguageIdentifier](./Common.xml#L99:~:text=An identifier to distinguish multiple texts in different languages for the same entity [TextFormat](./Common.xml#L104:~:text=The annotated property, parameter, or return type contains human-readable text that may contain formatting information [Timezone](./Common.xml#L117:~:text=The point in time represented by the annotated property or parameter shall be interpreted in the given time zone
Time zones shall be specified according to the [IANA](https://www.iana.org/time-zones) standard. If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone. -[IsDigitSequence](./Common.xml#L173:~:text=Contains only digits -[IsUpperCase](./Common.xml#L178:~:text=Contains just uppercase characters -[IsCurrency](./Common.xml#L183:~:text=Annotated property or parameter is a currency code -[IsUnit](./Common.xml#L188:~:text=Annotated property or parameter is a unit of measure -[UnitSpecificScale](./Common.xml#L192:~:text=The number of fractional decimal digits of a currency amount or measured quantity
The annotated property contains a currency code or unit of measure, and the annotation value specifies the default scale of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of fractional digits captured by that device. -[UnitSpecificPrecision](./Common.xml#L197:~:text=The number of significant decimal digits of a currency amount or measured quantity
The annotated property contains a currency code or unit of measure, and the annotation value specifies the default precision of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of significant digits captured by that device. -[SecondaryKey](./Common.xml#L203:~:text=Use term `AlternateKeys` from the OASIS Core vocabulary instead -[MinOccurs](./Common.xml#L215:~:text=The annotated set or collection contains at least this number of items -[MaxOccurs](./Common.xml#L219:~:text=The annotated set or collection contains at most this number of items -[AssociationEntity](./Common.xml#L223:~:text=Entity representing an n:m association with attributes -[DerivedNavigation](./Common.xml#L230:~:text=Shortcut for a multi-segment navigation, contains the long path with all its segments -[Masked](./Common.xml#L236:~:text=Use terms `MaskedValue` instead -[MaskedValue](./Common.xml#L251:~:text=Property contains sensitive data that is by default not transferred
By default a masked property is excluded from responses and instead an instance annotation with this term is sent, containing a masked value that can be rendered by user interfaces. -[RevealOnDemand](./Common.xml#L260:~:text=Unmasked data for this property can be requested with custom query option `masked-values=false` -[SemanticObject](./Common.xml#L266:~:text=Name of the Semantic Object represented as this entity type or identified by this property -[SemanticObjectMapping](./Common.xml#L269:~:text=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](./Common.xml#L282:~:text=List of actions that are not available in the current state of the instance of the Semantic Object -[IsInstanceAnnotation](./Common.xml#L286:~:text=Term can also be used as instance annotation; AppliesTo of this term specifies where it can be applied -[FilterExpressionRestrictions](./Common.xml#L316:~:text=Use term Capabilities.FilterRestrictions instead -[FieldControl](./Common.xml#L359:~:text=Control 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. -[ExceptionCategory](./Common.xml#L392:~:text=A machine-readable exception category -[Application](./Common.xml#L397:~:text=... -[Timestamp](./Common.xml#L417:~:text=... -[TransactionId](./Common.xml#L422:~:text=... -[ErrorResolution](./Common.xml#L427:~:text=Hints for resolving this error -[Messages](./Common.xml#L445:~:text=Collection of end-user messages
The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
The minimum structure is
- `code: Edm.String`
- `message: Edm.String`
- `target: Edm.String nullable`
- `additionalTargets: Collection(Edm.String)`
- `transition: Edm.Boolean`
- `numericSeverity: Edm.Byte`
- `longtextUrl: Edm.String nullable` -[additionalTargets](./Common.xml#L468:~:text=Additional targets for the message
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[longtextUrl](./Common.xml#L474:~:text=Location of the message long text
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[numericSeverity](./Common.xml#L480:~:text=Classifies an end-user message as info, success, warning, or error
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[MaximumNumericMessageSeverity](./Common.xml#L485:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) -[IsActionCritical](./Common.xml#L514:~:text=Criticality of the function or action to enforce a warning or similar before it's executed -[Attributes](./Common.xml#L518:~:text=Attributes related to this property, which may occur in denormalized entity types -[RelatedRecursiveHierarchy](./Common.xml#L522:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. -[Interval](./Common.xml#L526:~:text=An interval with lower and upper boundaries described by two properties -[ResultContext](./Common.xml#L544:~:text=The 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. -[SAPObjectNodeType](./Common.xml#L552:~:text=The SAP Object Node Type represented by the annotated entity type
SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. -[Composition](./Common.xml#L568:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. -[SAPObjectNodeTypeReference](./Common.xml#L577:~:text=The name of the SAP Object Node Type referenced by the annotated property -[IsNaturalPerson](./Common.xml#L582:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person -[ValueList](./Common.xml#L588:~:text=Specifies 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. -[ValueListRelevantQualifiers](./Common.xml#L662:~:text=List of qualifiers of relevant ValueList annotations
The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. -[ValueListWithFixedValues](./Common.xml#L668:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values -[ValueListForValidation](./Common.xml#L672:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation -[ValueListReferences](./Common.xml#L677:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property -[ValueListMapping](./Common.xml#L682:~:text=Specifies 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. -[IsCalendarYear](./Common.xml#L783:~:text=Property 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}) -[IsCalendarHalfyear](./Common.xml#L792:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] -[IsCalendarQuarter](./Common.xml#L801:~:text=Property 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] -[IsCalendarMonth](./Common.xml#L810:~:text=Property 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] -[IsCalendarWeek](./Common.xml#L819:~:text=Property 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] -[IsDayOfCalendarMonth](./Common.xml#L828:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. -[IsDayOfCalendarYear](./Common.xml#L836:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. -[IsCalendarYearHalfyear](./Common.xml#L844:~:text=Property 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] -[IsCalendarYearQuarter](./Common.xml#L854:~:text=Property 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] -[IsCalendarYearMonth](./Common.xml#L864:~:text=Property 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]) -[IsCalendarYearWeek](./Common.xml#L875:~:text=Property 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]) -[IsCalendarDate](./Common.xml#L885:~:text=Property 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. -[IsFiscalYear](./Common.xml#L902:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} -[IsFiscalPeriod](./Common.xml#L911:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} -[IsFiscalYearPeriod](./Common.xml#L920:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of 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}) -[IsFiscalQuarter](./Common.xml#L930:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsFiscalYearQuarter](./Common.xml#L938:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] -[IsFiscalWeek](./Common.xml#L947:~:text=Property encodes a fiscal 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] -[IsFiscalYearWeek](./Common.xml#L955:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsDayOfFiscalYear](./Common.xml#L964:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. -[IsFiscalYearVariant](./Common.xml#L971:~:text=Property encodes a fiscal year variant -[MutuallyExclusiveTerm](./Common.xml#L979:~:text=Only one term of the group identified with the Qualifier attribute can be applied -[DraftRoot](./Common.xml#L985:~:text=Root entities of business documents that support the draft pattern -[DraftNode](./Common.xml#L1012:~:text=Entities in this set are parts of business documents that support the draft pattern -[DraftActivationVia](./Common.xml#L1034:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets -[EditableFieldFor](./Common.xml#L1038:~:text=The annotated property is an editable field for the referenced key property -[SemanticKey](./Common.xml#L1060:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity -[SideEffects](./Common.xml#L1064:~:text=Describes side-effects of modification operations -[DefaultValuesFunction](./Common.xml#L1152:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
The default values function must have a bound overload whose binding parameter type matches the annotation target
- for an entity set: collection of entity type of entity set
- for a navigation property: identical to the type of the navigation property (single- or collection-valued)
- for a bound action/function: identical to the binding parameter type of the annotated action/function
In addition the overload can have non-binding parameters for values that the user has already entered:
- for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
- for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
- the properties of the entity to create, or
- the parameters of the action or function to call -[DerivedDefaultValue](./Common.xml#L1182:~:text=Function import to derive a default value for the property from a given context.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[FilterDefaultValue](./Common.xml#L1203:~:text=A default value for the property to be used in filter expressions. -[FilterDefaultValueHigh](./Common.xml#L1207:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. -[DerivedFilterDefaultValue](./Common.xml#L1212:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[SortOrder](./Common.xml#L1236:~:text=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. -[RecursiveHierarchy](./Common.xml#L1292:~:text=Defines a recursive hierarchy. -[CreatedAt](./Common.xml#L1324:~:text=Creation timestamp -[CreatedBy](./Common.xml#L1328:~:text=First editor -[ChangedAt](./Common.xml#L1332:~:text=Last modification timestamp -[ChangedBy](./Common.xml#L1336:~:text=Last editor -[OriginalProtocolVersion](./Common.xml#L1348:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` -[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1353:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ -[mediaUploadLink](./Common.xml#L1359:~:text=URL for uploading new media content to a Document Management Service
In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. -[PrimitivePropertyPath](./Common.xml#L1374:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property -[WebSocketBaseURL](./Common.xml#L1379:~:text=Base URL for WebSocket connections +[Locale](./Common.xml#L127:~:text=The value of the annotated property or parameter shall be interpreted in the given locale
Locales shall be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers). If this annotation is absent or null, the current user's or default locale is used.
An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent. +[IsDigitSequence](./Common.xml#L184:~:text=Contains only digits +[IsUpperCase](./Common.xml#L189:~:text=Contains just uppercase characters +[IsCurrency](./Common.xml#L194:~:text=Annotated property or parameter is a currency code +[IsUnit](./Common.xml#L199:~:text=Annotated property or parameter is a unit of measure +[UnitSpecificScale](./Common.xml#L203:~:text=The number of fractional decimal digits of a currency amount or measured quantity
The annotated property contains a currency code or unit of measure, and the annotation value specifies the default scale of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of fractional digits captured by that device. +[UnitSpecificPrecision](./Common.xml#L208:~:text=The number of significant decimal digits of a currency amount or measured quantity
The annotated property contains a currency code or unit of measure, and the annotation value specifies the default precision of numeric values with that currency code or unit of measure. Can be used in e.g. a list of available currency codes or units of measure, or a list of measuring devices to specify the number of significant digits captured by that device. +[SecondaryKey](./Common.xml#L214:~:text=Use term `AlternateKeys` from the OASIS Core vocabulary instead +[MinOccurs](./Common.xml#L226:~:text=The annotated set or collection contains at least this number of items +[MaxOccurs](./Common.xml#L230:~:text=The annotated set or collection contains at most this number of items +[AssociationEntity](./Common.xml#L234:~:text=Entity representing an n:m association with attributes +[DerivedNavigation](./Common.xml#L241:~:text=Shortcut for a multi-segment navigation, contains the long path with all its segments +[Masked](./Common.xml#L247:~:text=Use terms `MaskedValue` instead +[MaskedValue](./Common.xml#L262:~:text=Property contains sensitive data that is by default not transferred
By default a masked property is excluded from responses and instead an instance annotation with this term is sent, containing a masked value that can be rendered by user interfaces. +[RevealOnDemand](./Common.xml#L271:~:text=Unmasked data for this property can be requested with custom query option `masked-values=false` +[SemanticObject](./Common.xml#L277:~:text=Name of the Semantic Object represented as this entity type or identified by this property +[SemanticObjectMapping](./Common.xml#L280:~:text=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](./Common.xml#L293:~:text=List of actions that are not available in the current state of the instance of the Semantic Object +[IsInstanceAnnotation](./Common.xml#L297:~:text=Term can also be used as instance annotation; AppliesTo of this term specifies where it can be applied +[FilterExpressionRestrictions](./Common.xml#L327:~:text=Use term Capabilities.FilterRestrictions instead +[FieldControl](./Common.xml#L370:~:text=Control 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. +[ExceptionCategory](./Common.xml#L403:~:text=A machine-readable exception category +[Application](./Common.xml#L408:~:text=... +[Timestamp](./Common.xml#L428:~:text=... +[TransactionId](./Common.xml#L433:~:text=... +[ErrorResolution](./Common.xml#L438:~:text=Hints for resolving this error +[Messages](./Common.xml#L456:~:text=Collection of end-user messages
The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
The minimum structure is
- `code: Edm.String`
- `message: Edm.String`
- `target: Edm.String nullable`
- `additionalTargets: Collection(Edm.String)`
- `transition: Edm.Boolean`
- `numericSeverity: Edm.Byte`
- `longtextUrl: Edm.String nullable` +[additionalTargets](./Common.xml#L479:~:text=Additional targets for the message
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[longtextUrl](./Common.xml#L485:~:text=Location of the message long text
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[numericSeverity](./Common.xml#L491:~:text=Classifies an end-user message as info, success, warning, or error
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[MaximumNumericMessageSeverity](./Common.xml#L496:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) +[IsActionCritical](./Common.xml#L525:~:text=Criticality of the function or action to enforce a warning or similar before it's executed +[Attributes](./Common.xml#L529:~:text=Attributes related to this property, which may occur in denormalized entity types +[RelatedRecursiveHierarchy](./Common.xml#L533:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. +[Interval](./Common.xml#L537:~:text=An interval with lower and upper boundaries described by two properties +[ResultContext](./Common.xml#L555:~:text=The 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. +[SAPObjectNodeType](./Common.xml#L563:~:text=The SAP Object Node Type represented by the annotated entity type
SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. +[Composition](./Common.xml#L579:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. +[SAPObjectNodeTypeReference](./Common.xml#L588:~:text=The name of the SAP Object Node Type referenced by the annotated property +[IsNaturalPerson](./Common.xml#L593:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person +[ValueList](./Common.xml#L599:~:text=Specifies 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. +[ValueListRelevantQualifiers](./Common.xml#L673:~:text=List of qualifiers of relevant ValueList annotations
The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. +[ValueListWithFixedValues](./Common.xml#L679:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values +[ValueListForValidation](./Common.xml#L683:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation +[ValueListReferences](./Common.xml#L688:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property +[ValueListMapping](./Common.xml#L693:~:text=Specifies 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. +[IsCalendarYear](./Common.xml#L794:~:text=Property 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}) +[IsCalendarHalfyear](./Common.xml#L803:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] +[IsCalendarQuarter](./Common.xml#L812:~:text=Property 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] +[IsCalendarMonth](./Common.xml#L821:~:text=Property 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] +[IsCalendarWeek](./Common.xml#L830:~:text=Property 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] +[IsDayOfCalendarMonth](./Common.xml#L839:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. +[IsDayOfCalendarYear](./Common.xml#L847:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. +[IsCalendarYearHalfyear](./Common.xml#L855:~:text=Property 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] +[IsCalendarYearQuarter](./Common.xml#L865:~:text=Property 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] +[IsCalendarYearMonth](./Common.xml#L875:~:text=Property 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]) +[IsCalendarYearWeek](./Common.xml#L886:~:text=Property 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]) +[IsCalendarDate](./Common.xml#L896:~:text=Property 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. +[IsFiscalYear](./Common.xml#L913:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} +[IsFiscalPeriod](./Common.xml#L922:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} +[IsFiscalYearPeriod](./Common.xml#L931:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of 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}) +[IsFiscalQuarter](./Common.xml#L941:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsFiscalYearQuarter](./Common.xml#L949:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] +[IsFiscalWeek](./Common.xml#L958:~:text=Property encodes a fiscal 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] +[IsFiscalYearWeek](./Common.xml#L966:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsDayOfFiscalYear](./Common.xml#L975:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. +[IsFiscalYearVariant](./Common.xml#L982:~:text=Property encodes a fiscal year variant +[MutuallyExclusiveTerm](./Common.xml#L990:~:text=Only one term of the group identified with the Qualifier attribute can be applied +[DraftRoot](./Common.xml#L996:~:text=Root entities of business documents that support the draft pattern +[DraftNode](./Common.xml#L1023:~:text=Entities in this set are parts of business documents that support the draft pattern +[DraftActivationVia](./Common.xml#L1045:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets +[EditableFieldFor](./Common.xml#L1049:~:text=The annotated property is an editable field for the referenced key property +[SemanticKey](./Common.xml#L1071:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity +[SideEffects](./Common.xml#L1075:~:text=Describes side-effects of modification operations +[DefaultValuesFunction](./Common.xml#L1163:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
The default values function must have a bound overload whose binding parameter type matches the annotation target
- for an entity set: collection of entity type of entity set
- for a navigation property: identical to the type of the navigation property (single- or collection-valued)
- for a bound action/function: identical to the binding parameter type of the annotated action/function
In addition the overload can have non-binding parameters for values that the user has already entered:
- for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
- for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
- the properties of the entity to create, or
- the parameters of the action or function to call +[DerivedDefaultValue](./Common.xml#L1193:~:text=Function import to derive a default value for the property from a given context.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[FilterDefaultValue](./Common.xml#L1214:~:text=A default value for the property to be used in filter expressions. +[FilterDefaultValueHigh](./Common.xml#L1218:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. +[DerivedFilterDefaultValue](./Common.xml#L1223:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[SortOrder](./Common.xml#L1247:~:text=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. +[RecursiveHierarchy](./Common.xml#L1303:~:text=Defines a recursive hierarchy. +[CreatedAt](./Common.xml#L1335:~:text=Creation timestamp +[CreatedBy](./Common.xml#L1339:~:text=First editor +[ChangedAt](./Common.xml#L1343:~:text=Last modification timestamp +[ChangedBy](./Common.xml#L1347:~:text=Last editor +[OriginalProtocolVersion](./Common.xml#L1359:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` +[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1364:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ +[mediaUploadLink](./Common.xml#L1370:~:text=URL for uploading new media content to a Document Management Service
In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. +[PrimitivePropertyPath](./Common.xml#L1385:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property +[WebSocketBaseURL](./Common.xml#L1390:~:text=Base URL for WebSocket connections ## [TextFormatType](./Common.xml#L108:~:text=[SemanticObjectMappingType](./Common.xml#L273:~:text=[SemanticObjectMappingType](./Common.xml#L284:~:text=[FilterExpressionRestrictionType](./Common.xml#L327:~:text=[FilterExpressionRestrictionType](./Common.xml#L338:~:text=[FilterExpressionType](./Common.xml#L339:~:text=[FilterExpressionType](./Common.xml#L350:~:text=[FieldControlType](./Common.xml#L364:~:text=[FieldControlType](./Common.xml#L375:~:text=This annotation value does not imply any restrictions on the value range of the property. For restricting the value range use e.g. the standard type facet `Nullable` with a value of `false` to exclude the `null` value, or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md). -[Optional](./Common.xml#L370:~:text=This value does not make sense as a static annotation value. -[ReadOnly](./Common.xml#L374:~:text=To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead -[Inapplicable](./Common.xml#L378:~:text=This value does not make sense as a static annotation value.
Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international. -[Hidden](./Common.xml#L386:~:text=To statically hide a property on a UI use [UI.Hidden](UI.md#Hidden) instead +[Mandatory](./Common.xml#L377:~:text=This annotation value does not imply any restrictions on the value range of the property. For restricting the value range use e.g. the standard type facet `Nullable` with a value of `false` to exclude the `null` value, or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md). +[Optional](./Common.xml#L381:~:text=This value does not make sense as a static annotation value. +[ReadOnly](./Common.xml#L385:~:text=To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead +[Inapplicable](./Common.xml#L389:~:text=This value does not make sense as a static annotation value.
Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international. +[Hidden](./Common.xml#L397:~:text=To statically hide a property on a UI use [UI.Hidden](UI.md#Hidden) instead -## [ApplicationType](./Common.xml#L402:~:text=[ApplicationType](./Common.xml#L413:~:text=[ErrorResolutionType](./Common.xml#L432:~:text=[ErrorResolutionType](./Common.xml#L443:~:text=[NumericMessageSeverityType](./Common.xml#L490:~:text=[NumericMessageSeverityType](./Common.xml#L501:~:text=[IntervalType](./Common.xml#L529:~:text=[IntervalType](./Common.xml#L540:~:text=[SAPObjectNodeTypeType](./Common.xml#L560:~:text=[SAPObjectNodeTypeType](./Common.xml#L571:~:text=[ValueListType](./Common.xml#L592:~:text=[ValueListType](./Common.xml#L603:~:text=The value of the target property is used as the search expression instead of in $filter -[FetchValues](./Common.xml#L630:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath -[SelectionVariantQualifier](./Common.xml#L637:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L641:~:text=The value of the target property is used as the search expression instead of in $filter +[FetchValues](./Common.xml#L641:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath +[SelectionVariantQualifier](./Common.xml#L648:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L652:~:text=[FetchValuesType](./Common.xml#L646:~:text=[FetchValuesType](./Common.xml#L657:~:text=[ValueListMappingType](./Common.xml#L686:~:text=[ValueListMappingType](./Common.xml#L697:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation -[SelectionVariantQualifier](./Common.xml#L709:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L713:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation +[SelectionVariantQualifier](./Common.xml#L720:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L724:~:text=[*ValueListParameter*](./Common.xml#L718:~:text=[*ValueListParameter*](./Common.xml#L729:~:text=[ValueListParameterIn](./Common.xml#L723:~:text=[ValueListParameterIn](./Common.xml#L734:~:text=[ValueListParameterConstant](./Common.xml#L732:~:text=[ValueListParameterConstant](./Common.xml#L743:~:text=[ValueListParameterInOut](./Common.xml#L738:~:text=[ValueListParameterInOut](./Common.xml#L749:~:text=[ValueListParameterOut](./Common.xml#L752:~:text=[ValueListParameterOut](./Common.xml#L763:~:text=[ValueListParameterDisplayOnly](./Common.xml#L762:~:text=[ValueListParameterDisplayOnly](./Common.xml#L773:~:text=[ValueListParameterFilterOnly](./Common.xml#L770:~:text=[ValueListParameterFilterOnly](./Common.xml#L781:~:text=[DraftRootType](./Common.xml#L990:~:text=[DraftRootType](./Common.xml#L1001:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. -[AdditionalNewActions](./Common.xml#L1005:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. +[*PreparationAction*](./Common.xml#L1029:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. +[AdditionalNewActions](./Common.xml#L1016:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. -## [DraftNodeType](./Common.xml#L1017:~:text=[DraftNodeType](./Common.xml#L1028:~:text=[SimpleIdentifier](./Common.xml#L1042:~:text=[SimpleIdentifier](./Common.xml#L1053:~:text=[QualifiedName](./Common.xml#L1046:~:text=[QualifiedName](./Common.xml#L1057:~:text=[ActionOverload](./Common.xml#L1050:~:text=[ActionOverload](./Common.xml#L1061:~:text=[SideEffectsType](./Common.xml#L1067:~:text=[SideEffectsType](./Common.xml#L1078:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path -[TargetEntities](./Common.xml#L1089:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. -[TriggeredIndicator](./Common.xml#L1107:~:text=The value of this property typically is a Path expression pointing to a boolean property. It can be used by clients to defer expensive refresh calls until they are actually needed and instead just request the referenced indicator property. Servers can choose to return indicator properties even if not explicitly requested. -[Discretionary](./Common.xml#L1112:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. - -## [EffectType](./Common.xml#L1118:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path +[TargetEntities](./Common.xml#L1100:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. +[TriggeredIndicator](./Common.xml#L1118:~:text=The value of this property typically is a Path expression pointing to a boolean property. It can be used by clients to defer expensive refresh calls until they are actually needed and instead just request the referenced indicator property. Servers can choose to return indicator properties even if not explicitly requested. +[Discretionary](./Common.xml#L1123:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. + +## [EffectType](./Common.xml#L1129:~:text=[SortOrderType](./Common.xml#L1244:~:text=[SortOrderType](./Common.xml#L1255:~:text=If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being sorted according to the [`UI.PresentationVariant`](UI.md#PresentationVariant) or `Common.SortOrder` annotation, this instance of `UI.PresentationVariant/SortOrder` or `Common.SortOrder` MUST be silently ignored.
Allowed terms:
- [AggregatedProperty](#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) -[Descending](./Common.xml#L1272:~:text=If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being sorted according to the [`UI.PresentationVariant`](UI.md#PresentationVariant) or `Common.SortOrder` annotation, this instance of `UI.PresentationVariant/SortOrder` or `Common.SortOrder` MUST be silently ignored.
Allowed terms:
- [AggregatedProperty](#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[Descending](./Common.xml#L1283:~:text=[RecursiveHierarchyType](./Common.xml#L1297:~:text=[RecursiveHierarchyType](./Common.xml#L1308:~:text=[UserID](./Common.xml#L1340:~:text=[UserID](./Common.xml#L1351:~:text= + + + + + Locales shall be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers). +If this annotation is absent or null, the current user's or default locale is used. + +An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent. + + + - + - + - + - + @@ -222,11 +222,11 @@ - + - + @@ -829,7 +829,7 @@ The minimum structure is Property 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] + The string matches the regex pattern 0[1-9]|[1-4][0-9]|5[0-4] @@ -886,7 +886,7 @@ The minimum structure is Property 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]) + The string matches the regex pattern -?([1-9][0-9]{3,}|0[0-9]{3})(0[1-9]|[1-4][0-9]|5[0-4]) @@ -956,8 +956,7 @@ The minimum structure is - Property encodes a fiscal 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] + Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. @@ -965,8 +964,7 @@ The minimum structure is Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of - six digits, where the last two digits represent the week number in the year. - The string matches the regex pattern [1-9][0-9]{3}(0[1-9]|[1-4][0-9]|5[0-3]) + six digits, where the last two digits represent the week number in the year. From 05b0a4c8648679fc3f23d70f8cda87d7a33ca1af Mon Sep 17 00:00:00 2001 From: D024504 Date: Mon, 6 Dec 2021 13:21:03 +0100 Subject: [PATCH 5/8] shall -> must --- vocabularies/Common.json | 8 ++++---- vocabularies/Common.md | 4 ++-- vocabularies/Common.xml | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/vocabularies/Common.json b/vocabularies/Common.json index ca7c63d4..ab899fb3 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -155,8 +155,8 @@ "ReturnType" ], "@Common.Experimental": true, - "@Core.Description": "The point in time represented by the annotated property, parameter or return type shall be interpreted in the given time zone", - "@Core.LongDescription": "Time zones shall be specified according to the [IANA](https://www.iana.org/time-zones) standard.\n If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone.", + "@Core.Description": "The point in time represented by the annotated property, parameter or return type must be interpreted in the given time zone", + "@Core.LongDescription": "Time zones must be specified according to the [IANA](https://www.iana.org/time-zones) standard.\n If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone.", "@Core.RequiresType": "Edm.DateTimeOffset" }, "Locale": { @@ -168,8 +168,8 @@ "ReturnType" ], "@Common.Experimental": true, - "@Core.Description": "The value of the annotated property, parameter or return type shall be interpreted in the given locale", - "@Core.LongDescription": "Locales MUST be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers).\n If this annotation is absent or null, the current user's or default locale is used.\n An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent." + "@Core.Description": "The value of the annotated property, parameter or return type must be interpreted in the given locale", + "@Core.LongDescription": "Locales must be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers).\n If this annotation is absent or null, the current user's or default locale is used.\n An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent." }, "IsDigitSequence": { "$Kind": "Term", diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 5c467f10..a96ff856 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -19,8 +19,8 @@ Term|Type|Description [ExternalID](./Common.xml#L85:~:text=A human readable identifier for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.
If the annotated property is (part of) a foreign key of a resource, the external id is a human readable (part of an) identifier of this resource. There is a one-to-one relationship between each possible value of the annotated property and the corresponding external id. [IsLanguageIdentifier](./Common.xml#L99:~:text=An identifier to distinguish multiple texts in different languages for the same entity [TextFormat](./Common.xml#L104:~:text=The annotated property, parameter, or return type contains human-readable text that may contain formatting information -[Timezone](./Common.xml#L117:~:text=The point in time represented by the annotated property, parameter or return type shall be interpreted in the given time zone
Time zones shall be specified according to the [IANA](https://www.iana.org/time-zones) standard. If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone. -[Locale](./Common.xml#L127:~:text=The value of the annotated property, parameter or return type shall be interpreted in the given locale
Locales MUST be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers). If this annotation is absent or null, the current user's or default locale is used. An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent. +[Timezone](./Common.xml#L117:~:text=The point in time represented by the annotated property, parameter or return type must be interpreted in the given time zone
Time zones must be specified according to the [IANA](https://www.iana.org/time-zones) standard. If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone. +[Locale](./Common.xml#L127:~:text=The value of the annotated property, parameter or return type must be interpreted in the given locale
Locales must be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers). If this annotation is absent or null, the current user's or default locale is used. An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent. [IsDigitSequence](./Common.xml#L183:~:text=Contains only digits [IsUpperCase](./Common.xml#L188:~:text=Contains just uppercase characters [IsCurrency](./Common.xml#L193:~:text=Annotated property or parameter is a currency code diff --git a/vocabularies/Common.xml b/vocabularies/Common.xml index b9e69e0f..5d9f24c5 100644 --- a/vocabularies/Common.xml +++ b/vocabularies/Common.xml @@ -116,9 +116,9 @@ - + - Time zones shall be specified according to the [IANA](https://www.iana.org/time-zones) standard. + Time zones must be specified according to the [IANA](https://www.iana.org/time-zones) standard. If this annotation is absent or null, points in time are typically interpreted in the current user's or default time zone. @@ -126,9 +126,9 @@ - + - Locales MUST be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers). + Locales must be specified through a [Unicode Locale Identifier](https://www.unicode.org/reports/tr35/tr35.html#Identifiers). If this annotation is absent or null, the current user's or default locale is used. An example for the applicability of this annotation are calendar weeks, whose meaning is locale-dependent. From 9777a3403c333123fac48717fd1c2436499d0bb7 Mon Sep 17 00:00:00 2001 From: HeikoTheissen Date: Mon, 6 Dec 2021 14:45:30 +0000 Subject: [PATCH 6/8] auto-refreshed --- vocabularies/Common.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/vocabularies/Common.json b/vocabularies/Common.json index ab899fb3..f14a1236 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -502,6 +502,7 @@ "Timestamp": { "$Kind": "Term", "$Type": "Edm.DateTimeOffset", + "$Precision": 0, "@Common.Experimental": true, "@Core.Description": "...", "@Common.IsInstanceAnnotation": true @@ -1522,6 +1523,7 @@ "$AppliesTo": [ "EntityType" ], + "$Precision": 0, "@Core.Description": "Creation timestamp", "@Common.IsInstanceAnnotation": true }, @@ -1542,6 +1544,7 @@ "$AppliesTo": [ "EntityType" ], + "$Precision": 0, "@Core.Description": "Last modification timestamp", "@Common.IsInstanceAnnotation": true }, From dbad7b7e0883021bcdb6cb6235dddc2c14544c70 Mon Sep 17 00:00:00 2001 From: D024504 Date: Tue, 7 Dec 2021 10:53:03 +0100 Subject: [PATCH 7/8] extended timezone example --- examples/Common.Timezone-sample.json | 5 +++++ examples/Common.Timezone-sample.xml | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/examples/Common.Timezone-sample.json b/examples/Common.Timezone-sample.json index 28335ef7..0600d08c 100644 --- a/examples/Common.Timezone-sample.json +++ b/examples/Common.Timezone-sample.json @@ -13,6 +13,11 @@ "timezone.sample": { "WorkerTimeSheet": { "$Kind": "EntityType", + "WorkingWeek": { + "$Nullable": true, + "@Common.IsCalendarYearWeek": true, + "@Common.Locale": "de-DE" + }, "ClockInDateTime": { "$Type": "Edm.DateTimeOffset", "$Nullable": true, diff --git a/examples/Common.Timezone-sample.xml b/examples/Common.Timezone-sample.xml index e2a34f1a..5e1fd5ec 100644 --- a/examples/Common.Timezone-sample.xml +++ b/examples/Common.Timezone-sample.xml @@ -6,6 +6,10 @@ + + + + @@ -13,4 +17,4 @@ - + From 7d30ec3cba1cc3655db4988341129d901cb8d43d Mon Sep 17 00:00:00 2001 From: D024504 Date: Tue, 7 Dec 2021 12:17:32 +0100 Subject: [PATCH 8/8] Example list for this repository --- examples/README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/examples/README.md b/examples/README.md index ef2a43bd..f5dee6de 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,14 +1,18 @@ -# Annotation Examples +# Examples -Annotation examples are authored in XML and automatically translated to JSON. +## [Composition](Common.Composition-sample.xml) -Example file names should start with the alias-qualified term name, followed by a dash, an optional "qualifier" for the example file, and end with `examples.xml`, e.g. +This example shows how to declare a composition relationship between entity types of a business object. -- `Common.SideEffects-examples.xml` -- `Common.SideEffects-really.tricky.examples.xml` +## [SAP Object Node Type](Common.SAPObjectNodeType-sample.xml) -Each example file can contain one or more examples. +This example shows how to declare SAP Object Node Types. -Examples should be documented with `Core.Description`. +## [Temporal properties](Common.Timezone-sample.xml) -You can use the copy template `_vocab.Term-examples.xml` as a quickstart. +This example shows annotations of temporal properties: calendar weeks and timestamps. + +## [Dynamic properties](DynamicProperties-sample.xml) + +This example shows how dynamic properties that result from data aggregation can be handled in analogy with +structural properties.