@DataIntegration
BETA This annotation is beta and should be reviewed for completion and correctness.
Introduction
The DataIntegration annotations are used in the context of data integration scenarios to inform downstream consumers on specific behavior of elements and entities.
Schema Definitions
- This is an extension vocabulary for CSN Interop Effective Document.
- The interface is available as JSON Schema: dataintegration.schema.json.
Annotations Overview
| Annotation | Scope | Description |
|---|---|---|
| @DataIntegration.dataUnavailable | Type, Entity | Specifies that the data of the element or entity is unavailable although it is part of the output structure. |
| @DataIntegration.dataProduct.customDataProvider.partialKeyDefinition | Entity | Defines subset of key fields of the CDS entity used for DELETE operation during delta replication. Consistency Constraints: - Fields defined in the annotation must be key fields of the CDS entity. |
| @DataIntegration.technical | Type | Express by this annotation that an element is of technical nature used for data integration purposes and does not belong to the business data of the data product. |
@DataIntegration.dataUnavailable
Specifies that the data of the element or entity is unavailable although it is part of the output structure.
Scope: Type, Entity
Extending: BooleanType, StringType, LargeStringType, IntegerType, Int16Type, Integer64Type, UInt8Type, DecimalType, DoubleType, DateType, TimeType, DateTimeType, TimestampType, UUIDType, BinaryType, LargeBinaryType, AssociationType, CompositionType, CustomType, TypeDefinition, BooleanTypeDefinition, StringTypeDefinition, LargeStringTypeDefinition, IntegerTypeDefinition, Int16TypeDefinition, Integer64TypeDefinition, UInt8TypeDefinition, DecimalTypeDefinition, DoubleTypeDefinition, DateTypeDefinition, TimeTypeDefinition, DateTimeTypeDefinition, TimestampTypeDefinition, UUIDTypeDefinition, BinaryTypeDefinition, LargeBinaryTypeDefinition, AssociationTypeDefinition, CompositionTypeDefinition, EntityDefinition
Type: boolean
Introduced in Version: 1.2.3
@DataIntegration.dataProduct.customDataProvider.partialKeyDefinition
Defines subset of key fields of the CDS entity used for DELETE operation during delta replication.
Consistency Constraints:
- Fields defined in the annotation must be key fields of the CDS entity.
Scope: Entity
Extending: EntityDefinition
Type: Array<Element Reference>
Array Constraint: MUST have at least 1 items
Introduced in Version: 1.2.6
Example Values:
[
"AirlineCode",
"FlightConnectionNumber",
"FlightDate"
]
@DataIntegration.technical
Express by this annotation that an element is of technical nature used for data integration purposes and does not belong to the business data of the data product.
Scope: Type
Extending: BooleanType, StringType, LargeStringType, IntegerType, Int16Type, Integer64Type, UInt8Type, DecimalType, DoubleType, DateType, TimeType, DateTimeType, TimestampType, UUIDType, BinaryType, LargeBinaryType, AssociationType, CompositionType, CustomType, TypeDefinition, BooleanTypeDefinition, StringTypeDefinition, LargeStringTypeDefinition, IntegerTypeDefinition, Int16TypeDefinition, Integer64TypeDefinition, UInt8TypeDefinition, DecimalTypeDefinition, DoubleTypeDefinition, DateTypeDefinition, TimeTypeDefinition, DateTimeTypeDefinition, TimestampTypeDefinition, UUIDTypeDefinition, BinaryTypeDefinition, LargeBinaryTypeDefinition, AssociationTypeDefinition, CompositionTypeDefinition
Type: boolean
Constant Value: true
Introduced in Version: 1.2.6