Using ABAP Annotations in CDS Views

Copy the template data definition. If you have finished the previous exercise, you can skip this task and continue editing your data definition Z##_EMPLOYEE.

1. Copy the /LRN/R_EMPLOYEE data definition to a data definition in your own package (suggested name: Z##_EMPLOYEE, where ## stands for your group number).

   1. In the Project Explorer view, right-click the /LRN/R_EMPLOYEE data definition to open the context menu.

   2. From the context menu, choose Duplicate ....

   3. Enter the name of your package in the Package field. In the Name field, enter the name for the CDS view entity (Z##_Employee, where ## stands for your group number).

   4. Adjust the description and choose Next.

   5. Confirm the transport request and choose Finish.

2. Activate the copy.

   1. Press Ctrl + F3 to activate the data definition.

In your data definition, maintain the view annotations. Add an annotation that can be used to restrict data preview for a CDS view entity and adjust the values of the ObjectModel.usageType annotations.

1. At the beginning of the data definition, use code-completion to add annotation @ABAPCatalog.dataMaintenance with its default value.

   1. Place the cursor at the beginning of the first code row and press Enter to insert a new empty row.

   2. In the empty row, enter @A and press Ctrl + Space to invoke code-completion.

   3. From the suggestion list, choose @ABAPCatalog: { } (annotation.

   4. Enter a period sign (.) and press Ctrl + Space again.

   5. Choose dataMaintenance: #RESTRICTED (annotation).

2. Group the entity annotations that start with @ABAPCatalog.

   Hint

   You can use the syntax of the @ObjectModel.usageType annotation group as a blueprint.

   1. Adjust the code as follows:

      Code Snippet

      Copy code

      Copy code

      Switch to dark mode

      Switch to dark mode

      123456789
      
      // @AbapCatalog.dataMaintenance: #RESTRICTED
      // @AbapCatalog.viewEnhancementCategory: [#NONE]
        @AbapCatalog: {
          dataMaintenance: #RESTRICTED,
          viewEnhancementCategory: [#NONE]
        }
        @AccessControl.authorizationCheck: #NOT_REQUIRED
      

3. Display the documentation for the @ObjectModel.usageType annotations and maintain the values.

   Note

   You should make sure that the annotation values fit the technical table settings of your database table for employee data.

   1. Place the cursor on @ObjectModeland press F1 to open the ABAP language help.

   2. On the ABAP Language Help view that opens below the editor, choose@ObjectModel, CDS View annotations, View Entity.

   3. For the serviceQuality annotation, choose #D because the view does not support transactional processing.

   4. For the sizeCategory annotation, choose #M because we expect less than 100,000 data sets.

   5. For the dataClass annotation, choose #MASTER because employee data are maser data.

In your data definition, add the mandatory element annotation to establish the link between the annual salary and the currency code. Use the Active Annotations view to analyze the element labels that are derived from data elements and provide an alternative label for the CurrencyCode element.

1. In the element list, un-comment the AnnualSalary element and the CurrencyCode element.

   1. Select both code rows and press Ctrl + Shift + < to remove the comment signs from the beginning of each row.

2. Add the mandatory element annotation that identifies the AnnualSalary element as an amount and links it to theCurrencyCode element.

   Note

   You might need to add this annotation manually with the support of code completion. At the time of writing, the editor for data definitions does not offer a quick fix for this error. (The editor for database table definitions does.)

   1. Adjust the code as follows:

      Code Snippet

      Copy code

      Copy code

      Switch to dark mode

      Switch to dark mode

      12345
      
        department_id         as DepartmentId,
        annual_salary         as AnnualSalary,
        currency_code         as CurrencyCode,
      

3. Open the Active Annotations View and analyze the values of the EndUserText.Label annotation for the different view elements.

   1. Right-click anywhere in the source code of the data definition and choose Open With → Active Annotations.

      Result

      The Active Annotations view appears as a new tab below the editor view. The source of the end user texts is listed in the Origin Data Type column.

4. Return to the source code of your data definition and add element annotation EndUSerText.label for view element CurrencyCode. Change the label from Currency to Currency Key.

   1. Adjust the code as folows:

      Code Snippet

      Copy code

      Copy code

      Switch to dark mode

      Switch to dark mode

      12345
      
       @Semantics.amount.currencyCode: 'CurrencyCode'
       annual_salary         as AnnualSalary,
       currency_code         as CurrencyCode,
      

5. Activate the data definition.

   1. Press Ctrl + F3 to activate the development object.

6. Return to the Active Annotations view, refresh the display, and confirm that now the new label is active.

   Hint

   To find a specific annotation more easily, you can first collapse the entire tree and then expand the element and main annotation you are interested in.

   1. From the toolbar on the Active Annotations view, choose Refresh (F5). Alternatively, place the cursor anywhere on the view and press F5.

   2. From the toolbar on the Active Annotations view, choose Collapse All.

   3. Expand Z##_R_EMPLOYEE → CurrencyCode → @EndUserText.