Exercise 1

In this exercise, we will create a starter application to collect inventory data.

The usual process of development would be that you as a developer would now start to manually create the following repository objects for each entity

Table
CDS interface view
CDS projection view
Metadata Extension view
Behavior definition
Behavior implementation

before you can start with the implementation of the business logic.

To speed up the process we will use the RAP Generator that will generate a starter project for us containing all these objects. This way you can concentrate on developing the business logic of this extension scenario without the need to type lots of boiler plate coding beforehand.

Before using the RAP Generator you have to do the following:

Create a package for the repository objects of your RAP business object.
Create a class that will generate the RAP BO alongside with a table that to store the inventory data.

Since this is a green field scenario the application will be implemented using a managed business object that is based on the ABAP RESTful Application Programming Model (RAP).

This application will then be enhanced such that it leverages OData service calls and SOAP calls to retrieve data from a SAP S/4HANA backend. These services are either called as a value help or to perform a determination for the price of a product whenthe inventory data is created or updated.

Create a package
Run the RAP Generator
Check the generated repository objects
Behavior Implementation
Summary
Solution

Create a package

Richt-click on ZLOCAL and from the context menu choose New > ABAP Package.

In the Create new ABAP package dialogue enter the following values
- Name: Enter ZRAP_INVENTORY_####.
- Description: Enter a meaningful description for your package, e.g. Inventory demo ####.
Select or create a new transport request and click Finish.
Add your package to your Favorites Packages folder.
- Right click on the folder Favorites Packages
- and start to type ZRAP
- choose your package ZRAP_INVENTORY_#### from the list of machting items

Press Ok

Result

You have created a package in the super package ZLOCAL. The package ZLOCAL has a similar role as the package $TMP has in on premise systems.

You can see now an entry in the Transport Organizer view

Caution:

If you start developing in a non-trial system you should use sub-packages in ZLOCAL ONLY for tests but NOT for real development. For real development you have to create your own software components and own development packages.

Generate a starter application

Now after you have created a package we can start developing a class.

Right click on your package ZRAP_INVENTORY_####. Click New > ABAP Class.
In the New ABAP class dialgue enter the following values:
- Name: zcl_generate_dev268_#### .
- Description: Generate RAP BO for DEV268 - group ####.
Press Next.
Select a transport request and click Finish.
Copy and paste the code from the sources sub folder

zcl_generate_dev269_####

thereby replacing the placeholder #### in the template coding as shown in the following screen shot.
Replace the placeholder #### with your group number.

Press Ctrl+F to start the dialogue to search and replace the placeholder #### with your group number.
Activate your changes

Press .
Run the console application by pressing F9 or right-click on your class in the Project Explorer and choose Run as --> ABAP Application (Console)
Wait a short time and check the console tab for a success message

You should receive a success message in the Console Tab telling you

RAP BO ZI_RAP_Inventory_#### generated successfully

... and when you check the content of your package you will notice that it now contains 13 repository objects.
The coding of the class that you have created has done the following:
- Using the XCO framework it has created a table to store the inventory data
- It then has called the RAP Genertor which has generated the following repository objects for your convenience based on the table that has been generated beforehand
Business Services
- ZUI_RAP_INVENTORY_####_02 - Service Binding
- ZUI_RAP_INVENTORY_#### - Service Definition
CDS views
- ZC_RAP_INVENTORY_#### - Projection view
- ZI_RAP_INVENTORY_#### - Interface view
Metadata Extension
- ZC_RAP_INVENTORY_#### - MDE for the projection view
Behavior Defintion
- ZC_RAP_INVENTORY_#### - for the projection view
- ZI_RAP_INVENTORY_#### - for the interface view

What is now left is to publish the service binding since this can not be automated (yet).

Open the service binding and double click on ZUI_RAP_INVENTORY_####_O2
(in older versions of the RAP Generator it reads _02 instead of _O2)
Click on Publish to publish the Service Binding.
Select the entity Inventory and press the Preview button to start the Fiori Elements Preview.

(The service also contains an entity I_Currency since the RAP Generator has added a value help for Currencies to the projection view.)

Check the Fiori Elements Preview App. You will notice that we got a nearly full fledged UI with capabilities for
- Searching
- Filtering
- Create, Update and Delete inventory data

This is because all possible behaviors (create, update and delete) have been enabled by default in our generated code. You will see that all CRUD operations are working out of the box (apart from calculating the inventory id, which we will do in a second). In addition all columns of the table are displayed by default as well since we have generated appropriate UI annoations. If you do not want to see all columns (either on the list- or the object page) you can comment out these annotations. This is however much simpler than having to write all these annotations from scratch.

You can try and start entering values for your first inventory item. However no checks nor any value help have been implemented yet. Especially not for the determination of the semantic key InventoryId.

This we will do in the next step.

Check the generated repository objects

The interface view ZI_RAP_Inventory_#### was generated such that based on the ABAP field names aliases have been created such that the ABAP field name was converted into camelCase notation.

define root view entity ZI_RAP_INVENTORY_1234
  as select from zrap_inven_1234
{
  key UUID as UUID,  
  INVENTORY_ID as InventoryID,  
  PRODUCT_ID as ProductID,  
  @Semantics.quantity.unitOfMeasure: 'QuantityUnit'
  QUANTITY as Quantity,  
  QUANTITY_UNIT as QuantityUnit,
  ...
 }

The projection view ZC_RAP_Inventory_#### was generated such that it contains annotations for search and a value help for the field CurrencyCode.

define root view entity ZC_RAP_INVENTORY_####
  as projection on ZI_RAP_Inventory_####
{
  @Search.defaultSearchElement: true
  key UUID,
  
  @Search.defaultSearchElement: true
  InventoryID,
  
  ProductID,
  
  Quantity,
  
  QuantityUnit,
  
  @Semantics.amount.currencyCode: 'CurrencyCode'
  Price,
  
  @Consumption.valueHelpDefinition: [ {
    entity: {
      name: 'I_Currency', 
      element: 'Currency'
    }
  } ]
  CurrencyCode,

The behavior definion ZI_RAP_Inventory_#### was generated such that the field InventoryID which acts as a semantic key was marked as readonly.

field ( readonly ) InventoryID;

also a mapping was added that maps the ABAP field names to the field names of the CDS views.

  mapping for zrap_inven_1234
  {
    UUID = UUID;
    InventoryID = INVENTORY_ID;
    ProductID = PRODUCT_ID;
    Quantity = QUANTITY;
    QuantityUnit = QUANTITY_UNIT;
    Remark = REMARK;
    NotAvailable = NOT_AVAILABLE;
    CreatedBy = CREATED_BY;
    CreatedAt = CREATED_AT;
    LastChangedBy = LAST_CHANGED_BY;
    LastChangedAt = LAST_CHANGED_AT;
  }

And we find a determination that was generated for the semantic key field (that has to be implemented though).

Please make sure that the determination that is performed during the 'save* sequence for the InventoryID is triggered by 'create' operation. (in older versions the RAP Generator created a determination that acts on the modify operation)

determination CalculateInventoryID on save { create; }

Last but not least, you will find it handy that a Metadata Extension View ZC_RAP_Inventory_#### has also been generated that automatically publishes all field on the list page as well as on the object page by setting appropriate @UI annotations. Also the administrative fields like created_at as well as the UUID based key field are hidden by setting @UI.hidden to true.

   @UI.hidden: true
  UUID;
  
  @UI.lineItem: [ {
    position: 20 , 
    importance: #HIGH, 
    label: 'InventoryID'
  } ]
  @UI.identification: [ {
    position: 20 , 
    label: 'InventoryID'
  } ]
  @UI.selectionField: [ {
    position: 20 
  } ]
  InventoryID;
  
  @UI.lineItem: [ {
    position: 30 , 
    importance: #HIGH, 
    label: 'ProductID'
  } ]
  @UI.identification: [ {
    position: 30 , 
    label: 'ProductID'
  } ]
  ProductID;
  ...

Feel free to check out more of the generated code.

Behavior Implementation

In the Project Explorer navigate to Core Data Services > Behavior Definitions and double click on ZI_RAP_INVENTORY_####

In the source code you will see the warning

Class "ZBP_I_RAP_INVENTORY_1234" does not exist.
- Click on the name of the behavior implementation class ZBP_I_RAP_Inventory_####
- Press Ctrl+1 to open the quick fix / quick assist dialog

The quick fix offers you to create a global behavior implementation class zbp_i_rap_inventory_#### for the behavior definition zi_rap_inventory_####.

Double click on Create behavior implementation class zbp_i_rap_inventory_####

The New Behavior Definition dialogue opens - Leave the default settings and press Next
Select a transport request and press Finish
Implement the determination for the field InventoryID

The code of the behavior implementation contains already an (empty) implementation for the determiniation that shall calculate the semantic key InventoryID.

The implementation of the behavior defintion must (for technical reasons) take place in local classes that follow the naming convention lhc_<EntityName> (here lhc_Inventory). We suggest to use the source code shown below to implement the calculation of the semantic key of our managed business object for inventory data. In a productive application you would rather use a number range. To keep our implementation simple we will use the approach to simply count the number of objects that are available. By a simple increment of this number we get a semantic key which is readable by the users of our application.

 
 
METHOD CalculateInventoryID.

  "Ensure idempotence
    READ ENTITIES OF zi_rap_inventory_#### IN LOCAL MODE
      ENTITY Inventory
        FIELDS ( InventoryID )
        WITH CORRESPONDING #( keys )
      RESULT DATA(inventories).

    DELETE inventories WHERE InventoryID IS NOT INITIAL.
    CHECK inventories IS NOT INITIAL.

    "Get max travelID
    SELECT SINGLE FROM zrap_inven_#### FIELDS MAX( inventory_id ) INTO @DATA(max_inventory).

    "update involved instances
    MODIFY ENTITIES OF zi_rap_inventory_#### IN LOCAL MODE
      ENTITY Inventory
        UPDATE FIELDS ( InventoryID )
        WITH VALUE #( FOR inventory IN inventories INDEX INTO i (
                           %tky      = inventory-%tky
                           inventoryID  = max_inventory + i ) )
    REPORTED DATA(lt_reported).

    "fill reported
    reported = CORRESPONDING #( DEEP lt_reported ).

ENDMETHOD.

Replace the placeholders #### with your group number and activate your changes (Ctrl+F3)

Test the implementation.

Start the Fiori Elements preview and press the Create button.
Enter an arbritray product name
Press Save

Check the numbering for your semantic key

Summary

You have completed the exercise!

You are now able to:

Implement Behavior Definitions to enable create, update and delete operations and make fields read-only Implement Behavior Implementations so that ABAP code in determinations is run when an object is created.
Use the Fiori Elements preview to test your service

Continue with - Exercise 2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Exercise 1

Create a package

Generate a starter application

Check the generated repository objects

Behavior Implementation

Summary

Files

README.md

Latest commit

History

README.md

File metadata and controls

Exercise 1

Create a package

Generate a starter application

Check the generated repository objects

Behavior Implementation

Summary