In this first part of tutorial, I am going to show how to prepare a data model using SEGW transaction. If you got stuck, you can try to look at this official document that describes the process in more details.
Steps needed to create your first oData service
1. You need to prepare a database table that will be used for storing data. Below you can see the specific database table which is used in this example.
2. You need to run the transaction (t-code) SEGW and create your first project.
3. Click on Data Model > Import from DDIC structure. Follow all the steps using your created database table. At the end you should be able to see following table. Then select relevant keys and finish this process.
4. Creatable, updatable, deletable and addressable parameters need to be checked for your entity.
5. Now, you need to generate a runtime object. Select a property panel on your project by right click and choose Generate runtime action.
6. In Service implementation > UserSet > GetEntitySet click by right and choose Go to ABAP Workbench.
7. The main goal now is to redefine relevant methods in USERS_DPC_EXT class. See content of redefined methods below.
Implementation of redefined methods
USERSET_CREATE_ENTITY – CREATE odata method
|
1 2 3 4 5 6 7 8 |
METHOD userset_create_entity. DATA: ls_user TYPE zsa_users. io_data_provider->read_entry_data( IMPORTING es_data = ls_user ). INSERT INTO zsa_users VALUES ls_user. er_entity = ls_user. ENDMETHOD. |
USERSET_GET_ENTITY – GET odata method
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
METHOD userset_get_entity. DATA: lt_keys TYPE /iwbep/t_mgw_tech_pairs, ls_key TYPE /iwbep/s_mgw_tech_pair, lv_email TYPE char100, ls_user TYPE zsa_users. lt_keys = io_tech_request_context->get_keys( ). READ TABLE lt_keys WITH KEY name = 'EMAIL' INTO ls_key. lv_email = ls_key-value. SELECT SINGLE * FROM zsa_users INTO CORRESPONDING FIELDS OF ls_user WHERE email = lv_email. er_entity = ls_user. ENDMETHOD. |
USERSET_GET_ENTITYSET – GET odata method
|
1 2 3 4 5 6 |
METHOD userset_get_entityset. DATA lt_users TYPE TABLE OF zsa_users. SELECT * FROM zsa_users INTO TABLE lt_users. et_entityset = lt_users. ENDMETHOD. |
USERSET_UPDATE_ENTITY – PUT odata method
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
METHOD userset_update_entity. DATA: ls_user TYPE zsa_users. io_data_provider->read_entry_data( IMPORTING es_data = ls_user ). UPDATE zsa_users SET firstname = ls_user-firstname lastname = ls_user-lastname age = ls_user-age address = ls_user-address WHERE email = ls_user-email. er_entity = ls_user. ENDMETHOD. |
USERSET_DELETE_ENTITY – DELETE odata method
|
1 2 3 4 5 6 7 8 9 10 11 |
METHOD userset_delete_entity. DATA: lt_keys TYPE /iwbep/t_mgw_tech_pairs, ls_key TYPE /iwbep/s_mgw_tech_pair, lv_email TYPE char100. lt_keys = io_tech_request_context->get_keys( ). READ TABLE lt_keys WITH KEY name = 'EMAIL' INTO ls_key. lv_email = ls_key-value. DELETE FROM zsa_users WHERE email = lv_email. ENDMETHOD. |
Testing your oData service
There is a gateway client which can be used for testing running services. Just run transaction(t-code) /IWFND/GW_CLIENT and you can find out, if your service runs correctly.
Your oData service is running, now you can start to consume your data!
If you miss anything in the article, let me know in the comments.
