--- parser: v2 auto_validation: true primary_tag: software-product>sap-btp--abap-environment tags: [ tutorial>beginner, programming-tool>abap-development, software-product>sap-business-technology-platform ] time: 15 author_name: Merve Temel author_profile: https://github.com/mervey45 slug: abap-environment-soap-web-services canonical_url: https://developers.sap.com/tutorials/abap-environment-soap-web-services --- # Consume SOAP Based Web Services with SAP BTP, ABAP Environment Consume SOAP based web services with SAP BTP, ABAP environment. ## Prerequisites - You need an SAP BTP, ABAP Environment [trial user](abap-environment-trial-onboarding) or a license. ## You will learn - How to save WSDL files - How to create ABAP package - How to create service consumption models - How to create ABAP classes - How to consume SOAP based web services --- ### Save WSDL file 1. Save following code snippet as `EPM_Product_SOAP.WSDL`. This WSDL file will be used in the next steps. ```WSDL false false false false false 0050568C901D1ED79182D1F2706880F5 no false true false ``` ### Create ABAP package 1. Open Eclipse, logon to your trial account and right-click **`ZLOCAL`**, select **New** > **ABAP Package**. ![package](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/package.png) 2. Create a new ABAP package: - Name: **`ZSC_SOAP_XXX`** - Description: **SOAP package** - `Superpackage`: `ZLOCAL` ![package](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/package2.png) Click **Next >**. 3. Click **Finish**. ![package](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/package3.png) HINT: Everything should be created in the same package. ### Create service consumption model 1. Add your package `ZSC_SOAP_XXX` to **Favorite Packages** . ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model.png) 2. Select your package `ZSC_SOAP_XXX` and right-click **New** > **Other ABAP Repository Object**. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model2.png) 3. Select **Service Consumption Model**. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model31.png) Click **Next >**. 4. Create a new service consumption model: - Name: **`ZSC_SCM_XXX`** - Description: **Service consumption model** - Remote Consumption Mode: **`Web Service`** ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model3.png) Click **Next >**. 5. Select `EPM_Product_SOAP.WSDL` as service metadata file and `ZSC_` as prefix. The prefix makes it easier to obtain unique ABAP names in the system, for all objects that are created. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model4.png) Click **Next >**. 6. Click **Finish**. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model5.png) 7. Open your service consumption model `ZSC_SCM_XXX` and **activate** it. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/activate.png) 8. In the Project Explorer you see all the dependent objects generated along with the Service Consumption Model. Your project explorer should look like following. If you don't see the changes yet, select your package `ZSC_SOAP_XXX` press `F5` to refresh. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/result.png) 9. The web service has a single operation, for which a code snippet is presented. Click **Copy to Clipboard**. ![model](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/model6.png) ### Consume web service This step shows a simple example of a web service consumption. 1. Right-click **Source Code Library** and select **New ABAP Class**. ![class](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/class.png) 2. Create a new ABAP class: - Name: **`ZSC_CALL_SERVICE_XXX`** - Description: **Class to call service** ![class](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/class2.png) Click **Next >**. 3. Click **Finish**. ![class](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/class3.png) 4. Implement the interface `if_oo_adt_classrun`: ```ABAP CLASS zsc_call_service_xxx DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. interfaces if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zsc_call_service_xxx IMPLEMENTATION. METHOD if_oo_adt_classrun~main. ENDMETHOD. ENDCLASS. ``` 5. Paste the copied code snippet inside the main method. 6. Adjust your code, change your `DATA(destination)` to: `DATA(destination) = cl_soap_destination_provider=>create_by_url( i_url = ).` The code snippet intends to use a destination from the destination service. In ABAP trial no destination service is available. Alternatively endpoint URL can be passed directly in coding. 7. Open `EPM_Product_SOAP.WSDL` and copy the endpoint URL. ![class](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/class4.png) Add the endpoint URL to your destination: `data(destination) = cl_soap_destination_provider=>create_by_url( i_url = 'https://sapes5.sapdevcenter.com/sap/bc/srt/xip/sap/zepm_product_soap/002/epm_product_soap/epm_product_soap').` ![class](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/destination2.png) 8. So far the request payload is empty. Provide a valid product to retrieve the price for, e.g. `HT-1000`: ```ABAP DATA(request) = VALUE zsc_req_msg_type( req_msg_type-product = 'HT-1000' ). ``` 9. Add the following line to output the response: ```ABAP out->write( |{ response-res_msg_type-price } { response-res_msg_type-currency }| ). ``` Save and activate. 10. This should be your end result. Your code should look like this: ```ABAP CLASS zsc_call_service_xxx DEFINITION PUBLIC FINAL CREATE PUBLIC . PUBLIC SECTION. INTERFACES if_oo_adt_classrun. PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. CLASS zsc_call_service_xxx IMPLEMENTATION. METHOD if_oo_adt_classrun~main. TRY. DATA(destination) = cl_soap_destination_provider=>create_by_url( i_url = 'https://sapes5.sapdevcenter.com/sap/bc/srt/xip/sap/zepm_product_soap/002/epm_product_soap/epm_product_soap'). DATA(proxy) = NEW zsc_co_epm_product_soap( destination = destination ). DATA(request) = VALUE zsc_req_msg_type( req_msg_type-product = 'HT-1000' ). proxy->get_price( EXPORTING input = request IMPORTING output = DATA(response) ). out->write( |{ response-res_msg_type-price } { response-res_msg_type-currency }| ). "handle response CATCH cx_soap_destination_error. "handle error CATCH cx_ai_system_fault. "handle error CATCH zsc_cx_fault_msg_type. "handle error ENDTRY. ENDMETHOD. ENDCLASS. ``` 11. Save and activate your coding. Press `F9` to run your console application. The price should come back as a result. ![class](https://raw.githubusercontent.com/sap-tutorials/abap-core-development/main/tutorials/abap-environment-soap-web-services/class6.png) ### Test yourself ## More Information - [SAP Help Portal: Consuming a Web Service](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/8b6723b265d54c13866fbade4a7a087b.html) ---