How To Fix ESH_ENG_CDSVAL_ES005 - 'key' must be annotated at an element

SAP Error Message - Details

• Message type: E = Error

• Message class: ESH_ENG_CDSVAL_ES - ES-CDS/ABAP: Validation of domain @EnterpriseSearch

• Message number: 005

• Message text: 'key' must be annotated at an element

What causes this issue?

@EnterpriseSearch.key can be annotated at a view element only.

System Response

The system issues an error message and will not allow you to continue with this transaction until the error is resolved.

How to fix this error?

Remove the annotation wherever it does not relate to a view element.
This annotation is obsolete; it has been replaced by
@ObjectModel.semanticKey!

Procedure for System Administrators

Error message extract from SAP system. Copyright SAP SE.

Smart SAP Assistant

• What is the cause and solution for SAP error message ESH_ENG_CDSVAL_ES005 - 'key' must be annotated at an element ?

  The SAP error message ESH_ENG_CDSVAL_ES005 indicates that a key must be annotated at an element in a Core Data Services (CDS) view. This error typically arises when you are defining a CDS view and you have not properly specified the key fields that uniquely identify records in the view.
  Cause:
  
  Missing Key Annotation: The error occurs when one or more fields that should be designated as keys in the CDS view are not annotated with the @Key annotation.
  Incorrect Field Definition: The fields that are intended to serve as keys may not be correctly defined or may be missing altogether.
  CDS View Structure: The structure of the CDS view may not align with the requirements for key fields, especially if the view is intended to be used in scenarios that require unique identification of records.
  
  Solution:
  To resolve this error, you need to ensure that the appropriate fields in your CDS view are annotated as keys. Here’s how you can do that:
  
  
  Identify Key Fields: Determine which fields in your CDS view should be treated as keys. These are typically fields that uniquely identify a record.
  
  
  Add Key Annotations: Modify your CDS view definition to include the @Key annotation for the identified key fields. Here’s an example of how to do this:
  define view ZMy_CDS_View
  as select from my_table
  {
      key field1,
      key field2,
      field3,
      field4
  }
  In this example, field1 and field2 are designated as key fields.
  
  
  Check for Composite Keys: If your key consists of multiple fields, ensure that all of them are annotated with @Key.
  
  
  Activate the CDS View: After making the necessary changes, activate the CDS view to see if the error is resolved.
  
  
  Related Information:
  
  CDS Annotations: Familiarize yourself with the various annotations available in CDS views, especially those related to keys, such as @Key, @AbapCatalog.sqlViewName, and others.
  SAP Documentation: Refer to the official SAP documentation for Core Data Services to understand best practices and guidelines for defining CDS views.
  Debugging: If the error persists after making changes, consider checking for other potential issues in the CDS view definition or related database tables.
  
  By ensuring that your CDS view has the correct key annotations, you should be able to resolve the ESH_ENG_CDSVAL_ES005 error.