@Consumption

BETA This annotation is beta and should be reviewed for completion and correctness.

Introduction

Via those Annotations the specific behavior is defined which is related to the consumption of CDS content via domain-specific frameworks. This metadata makes no assumptions on the concrete consumption technology/infrastructure but is applicable across multiple consumption technologies (Analytics, OData, …).

Schema Definitions

• This is an extension vocabulary for CSN Interop Effective.

Annotations Overview

Annotation	Scope	Description
@Consumption.valueHelpDefinition	Entity, Type	The property defines how value helps for this element shall be constructed. It allows to associate a (set of) View/Entity that provides the "Value Help" for the annotated field or parameter. This is achieved by either referencing the target view/entity of a modelled association or by directly establishing a relationship to view/entity that shall act as a value help provider.

@Consumption.valueHelpDefinition

The property defines how value helps for this element shall be constructed.

It allows to associate a (set of) View/Entity that provides the "Value Help" for the annotated field or parameter. This is achieved by either referencing the target view/entity of a modelled association or by directly establishing a relationship to view/entity that shall act as a value help provider.

Type: Array<Consumption Value Help Definition>
Scope: Entity, Type
Extending: EntityDefinition, BooleanType, StringType, LargeStringType, IntegerType, Integer64Type, DecimalType, DoubleType, DateType, TimeType, DateTimeType, TimestampType, UUIDType, AssociationType, CompositionType, CustomType, TypeDefinition

Consumption Value Help Definition

Property	Type	Description
entity OPTIONAL	Consumption Value Help Definition	Value help defining view or entity.
additionalBinding OPTIONAL	Array<Additional Binding>	Additional bindings for filtering the value help result list.
association OPTIONAL	Element Reference	Reference to the modelled association (in local entity) for which the target view represents the value help providing view or entity for the annotated local field. The on-condition of the association may only contain bindings of the source and target fields that use an equal operator. All these bindings are automatically considered by the value help for both filter and result mappings. Mutually exclusive to the usage of valueHelpDefinition.entity.
distinctValues OPTIONAL	boolean	Specifies whether the value help result list shall only contain distinct values for the annotated field or parameter. If set to true all mappings will be used for filtering, but only the value for the field/parameter which the value help was requested for will be returned by the value help. Default Value: true

Example Values

{
  "entity": {
    "name": "I_ControllingAreaStdVH",
    "element": "ControllingArea"
  }
}

{
  "entity": {
    "name": "I_CostCenterStdVH",
    "element": "CostCenter"
  },
  "additionalBinding": [
    {
      "localElement": "ControllingArea",
      "element": "ControllingArea"
    }
  ]
}

{
  "association": {
    "=": "to_Airline"
  }
}

Consumption Value Help Definition

Value help defining view or entity.

Property	Type	Description
name OPTIONAL	string	Name of the value help providing view or entity
element OPTIONAL	string	Name of the field of the value help view or entity, which the annotated local field or parameter is bound to. Mutually exclusive to the usage of valueHelpDefinition.association.

Additional Binding

Allows to define additional bindings (besides the ones defined by valueHelpDefinition.association or valueHelpDefinition.entity) for filtering the value help result list and/or returning values from the selected value help record.

Property	Type	Description
localElement OPTIONAL	string	Field of the current view/entity; mutually exclusive to the usage of localParameter.
element OPTIONAL	string	Name of the field of the value help view or entity, which the annotated local field or parameter is bound to.
usage OPTIONAL	@Consumption.ConsumptionValueHelpDefinition.AdditionalBinding.Usage	The binding may either specify an additional filter-criterion on the value help list (#FILTER), or an additional result mapping for the selected value help record (#RESULT) or a combination thereof (#FILTER_AND_RESULT). If not specified explicitly the usage is #FILTER_AND_RESULT. If distinctValues is set to true, additional bindings must specify the usage as #FILTER.

@Consumption.ConsumptionValueHelpDefinition.AdditionalBinding.Usage

The binding may either specify an additional filter-criterion on the value help list (#FILTER), or an additional result mapping for the selected value help record (#RESULT) or a combination thereof (#FILTER_AND_RESULT). If not specified explicitly the usage is #FILTER_AND_RESULT. If distinctValues is set to true, additional bindings must specify the usage as #FILTER.

Property	Type	Description
# MANDATORY	string	Provide the value in { "#": "<value>" } enum notation. Default Value: FILTER_AND_RESULT Allowed Values: "FILTER" "RESULT" "FILTER_AND_RESULT"

Example Values

{
  "#": "FILTER_AND_RESULT"
}