Skip to Content
Author's profile photo Jerry Wang

An example to help you understand how does ADT work

Have you even thought about why you could operate on ABAP backend system using ADT?

This document just gives a brief introduction about how does the ADT backend infrastructure respond your operation done in Eclipse. It contains a hands-on exercise which you could finish in your own ABAP system.

Explore ADT by switching on ABAP communication log

In order to explore what has happened when we do operations in Eclipse, we need to switch on ABAP communication log.

Click Windows->show view. Make view “ABAP Communication Log” is displayed.


Then click button “Start Logging”:


Try to create one report:


And then you could observe several logs for this report creation. The latest log appears in the topmost of the table.


Now you could know that your operation in Eclipse is sent to ABAP backend system via HTTP Get and HTTP Post with dedicated url and gets processed in ABAP backend. Double click on each line to get the detail view.

In the report creation scenario, the request sent to ABAP backend are just the same as normal what you have done in SAP GUI to create one report:

1. a query is sent via to check whether the report ZTEST_REPORT_JERRY already exists or not.


2. Do transport checks based on the package name we have specified.


3. once all checks pass, send the report creation request via HTTP post.

An example to understand how does ADT infrastructure responds

And how these HTTP request are handled in ABAP backend? Just set breakpoint on the function module SADT_REST_RFC_ENDPOINT, which acts as the central dispatcher and the entry point for all request sent from Eclipse. You should observe that this FM will be called again and again, once you have done something in Eclipse.


If you are patient enough, you could start debugging from this FM to learn how different handlers within the ADT backend infrastructure orchestrate to respond Eclipse front-end.

I write a simple report to simulate the HTTP request sent from Eclipse:

DATA: lv_request  TYPE sadt_rest_request,
      lv_response TYPE sadt_rest_response,
      lv_header   LIKE LINE OF lv_request-header_fields.
lv_request-request_line-method = 'GET'.
lv_request-request_line-uri = '/sap/bc/adt/crm/product/STAB_PROD_01'.
lv_request-request_line-version = 'HTTP/1.1'.
    request  = lv_request
    response = lv_response.

The url ‘/sap/bc/adt/crm/product/STAB_PROD_01’ has prefix /sap/bc/adt/ and is passed into the central dispatcher FM, so it could be processed by the ADT infrastructure. After we have studied how this simple program does work, we have already know the magic of the ADT processing logic.

After report execution, we could get the description of the product specified in url, ‘STAB_PROD_01’, from the variable lv_response.



And below are steps how to build this sample in your system.

1. Create a BAdI implementation on BAdI definition BADI_ADT_REST_RFC_APPLICATION

You could find lots of standard implementation already created on this BAdI definition, each for their specific use case.


maintain the filter value as below, so that the very url containing the filter value will be handled by this BAdI implementation.


Implement method register_workspaces by just copying below code:

 method if_adt_discovery_provider~register_workspaces.
    data workspace type ref to if_adt_discovery_workspace.
    data discovery type ref to if_adt_disc_rest_rc_registry.
    workspace = registry->register_workspace( me->get_application_title( ) ).
    discovery = lcl_discovery=>create_instance(
        workspace   = workspace
        static_path = me->if_adt_rest_rfc_application~get_static_uri_path( ) ).
    me->register_resources( discovery ).
    workspace->finalize( ).

For method get_application_title, you can just hard code something.

Implement method register_resources:

      template      = '/crm/product/{product_id}'
      handler_class = 'ZCL_ADT_RES_PRODUCT' ).

We will create and implement handler class ZCL_ADT_RES_PRODUCT in next step.

2. Create resource class ZCL_ADT_RES_PRODUCT

In this example, resource class is responsible for retrieve the product description for the product whose id is passed in via url and serialize the description via content handler class ( which will be created in step3 ) and set response accordingly.

Set CL_ADT_REST_RESOURCE as super class and only redefine method GET:

  DATA:     lv_product_id   TYPE comm_product-product_id,
            lv_product_type TYPE comm_product-product_type,
            lv_description  TYPE comm_prshtext-short_text,
            lv_text         TYPE comm_prshtext,
            lv_product      TYPE comm_product,
            lv_data         TYPE zcl_adt_res_pro_content_handle=>ty_product,
            content_handler TYPE REF TO if_adt_rest_content_handler.
      name      = 'product_id'
      mandatory = abap_true
      value     = lv_product_id ).
  SELECT SINGLE * FROM comm_product INTO lv_product WHERE product_id = lv_product_id.
  IF sy-subrc = 4.
    RAISE EXCEPTION TYPE cx_adt_res_not_found.
  lv_data-product_id = lv_product-product_id.
  lv_data-product_type = lv_product-product_type.
  SELECT SINGLE * INTO lv_text FROM comm_prshtext WHERE product_guid = lv_product-product_guid.
  lv_data-description = lv_text-short_text.
  CREATE OBJECT content_handler TYPE zcl_adt_res_pro_content_handle.
  response->set_body_data( content_handler = content_handler
                             data            = lv_data ).

3. create content handler class ZCL_ADT_RES_PRO_CONTENT_HANDLE

Set CL_ADT_REST_ST_HANDLER as super class, implement CONSTRUCTOR as below:

 super->constructor( st_name = co_st_name root_name = co_root_name content_type = co_content_type ).

Define three attributes as below. CO_ST_NAME just contains the technical name of transformation ID which you could find in transaction STRANS, and co_root_name contains the name of root node in XML response.


Create two public types:


    BEGIN OF ty_product,
      product_id type comm_product-product_id,
      product_type  type comm_product-product_type,
      description   type COMM_PRSHTEXT-SHORT_TEXT,
     END OF ty_product .
    tt_product TYPE STANDARD TABLE OF ty_product .​

Test the sample

1. our BAdI implementation is returned by GET BADI according to the correct filter value:


2. Our resource class get called. And the redefined method GET will be executed:


3. our content handler class is called to transforma the ABAP data into XML using the standard transformation “ID”:


Hope this sample gives you a better understanding on how does ADT work.

Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Vijay Chintarlapalli
      Vijay Chintarlapalli

      Very good document 🙂

      Author's profile photo Marvin Qian
      Marvin Qian

      Hi Jerry,

      Thanks a lot for your informative post. Though it's already been a long time since you posted the document till now, if you seen the comment, do you know where can get more references?


      Thanks and Regards,


      Author's profile photo Sitakant Tripathy
      Sitakant Tripathy

      Hi Marvin,

      I guess class CL_ADT_REST_RESOURCE would be your starting point. This one is then followed by individual implementations for relevant scenarios and objects.

      Hope this helps..



      Author's profile photo Bärbel Winkler
      Bärbel Winkler

      Jerry Wang

      Hi Jerry,

      thanks for this write-up upon which I happened today while trying to figure out if there’s an alternative for Eclipse/ADT to workbench-related user exits like EXIT_SAPLSEDD_001 (h/t to Nabheet Madan and his blog post which brought me here). I have to admit that I barely get the gist of what you explain in your blog post, but would this be a possible solution for our issue? And I do realise that I may be grasping at straws!

      Thanks much and Cheers


      Author's profile photo Nabheet Madan
      Nabheet Madan
      Bärbel Winkler this enhancement spot can definitely help you in the situation you are facing with Eclipse. I am still wondering normally SAP design a solution in such a way it does break existing enhancements but sadly looks like this is not the case.


      Author's profile photo Bärbel Winkler
      Bärbel Winkler

      Has anyone implemented Jerry's example successfully? I'm trying to follow the steps outlined but - most likely due to me not completely grasping what needs to be done where and when - I'm getting syntax errors when implementing method register_workspaces by copying the provided code.

      I for example get "lcl_discovery is not defined" but don't really know where this needs to be defined and how. Is there something missing in the write-up or am I just missing something obvious?

      Also, the instruction "For method get_application_title, you can just hard code something." left me somewhat puzzled as it wasn't readily apparent what needed to be defined here. With the help of a colleague I worked out that it basically just needed a returning parameter with whatever name and e.g. type of string. For somebody like me who is still quickly confused when ABAP OO is involved, a more detailed description would have helped to at least keep frustration levels low.