Category: ABAP

Preface – This post is part of the SAP ABAP OData Tutorial series.

Introduction

SAP provides Internet Communication Framework (ICF) services that needs to be activated after your OData Service is registered and active. The ICF is an API service enables an ABAP program to communicate with the Internet. In our last article, we have activated our OData services, let us explore more about SICF nodes in this article.

Steps to Activate OData Services

1. Go to the transaction SICF (Maintain Services) and search for your OData Service Name as shown below:
   
2. Now, activate the following service nodes (if available):
   1. /default_host/sap/bc/ui5_ui5
   2. /default_host/sap/bc/ui5_ui5/sap/<your service name>
   3. /default_host/sap/bc/bsp/sap/<your service name>
   4. /default_host/sap/opu/odata/sap/<your service name>
3. To activate an ICF service, select the required service node in the ICF tree.
4. Activate the ICF service in one of the following ways:
   1. In the menu, select option Service/Host  Activate
   2. In the context menu select Activate Service. (By Right Clicking on the node as shown below)

Steps to Activate Services for Fiori Launchpad

1. Go to the transaction SICF (Maintain Services) and search for your OData Service Name as shown below:
   
2. Now, activate the following service nodes (if available):
   1. /default host/sap/bc/ui2/nwbc/
   2. /default_host/sap/bc/ui2/start_up
   3. /default_host/sap/bc/ui5_ui5/sap/ar_srvc_launch
   4. /default_host/sap/bc/ui5_ui5/sap/ar_srvc_news
   5. /default_host/sap/bc/ui5_ui5/sap/arsrvc_upb_admn
   6. /default_host/sap/bc/ui5_ui5/ui2/ushell
   7. /default_host/sap/public/bc/ui2
   8. /default_host/sap/public/bc/ui5_ui5
3. To activate an ICF service, select the required service node in the ICF tree and choose hierarchy icon to activate all the child nodes under the chosen service.
4. Activate the ICF service in one of the following ways:
   1. In the menu, select option Service/Host Activate
   2. In the context menu select Activate Service (By Right Clicking on the node as shown below)

Steps to Activate Services for Web Dynpro ABAP

1. Go to the transaction SICF (Maintain Services) and search for your OData Service Name as shown below:
   
2. Now, activate the following service nodes (if available):

1. 1. /default_host/sap/bc/webdynpro [Activate only the node and not the subnodes]
   2. /default_host/sap/public/bc [This node will be activated automatically once the given subnodes are activated]
      1. /default_host/sap/public/bc/ur
      2. /default_host/sap/public/bc/icons
      3. /default_host/sap/public/bc/icons_rtl
      4. /default_host/sap/public/bc/webicons
      5. /default_host/sap/public/bc/pictograms
      6. /default_host/sap/public/bc/webdynpro/* (ssr, mimes, etc.)
      7. /default_host/sap/public/myssocntl

3. To activate an ICF service, select the required service node in the ICF tree.

4. Activate the ICF service in one of the following ways:

1. In the menu, select option Service/Host Activate
2. In the context menu select Activate Service (By Right Clicking on the node as shown below)

Preface – This post is part of the SAP ABAP OData Tutorial series.

Introduction

Once we have created an OData in SEGW. The very next step is to register the OData. After registering only we can access the SAP OData service. By registering, we mean we open our service to the internet. We can Register the service in two ways:

• From the transaction SEGW
• From the transaction /n/IWFND/MAINT_SERVICE

Steps to Register an OData service using SEGW

Once the OData is generated, now it is the time to register the service. Once the service is registered, then only it can be used anywhere.

To generate an OData, follow the given steps:

1. Double click the node Service Maintenance
2. Select any System and click Register as shown below:
   
3. Enter an Alias, if asked as shown below:
   
4. Now, in the next screen you get following options:

Field	Description
Technical Service Name	This is auto generated service name
Service Version	It is auto generated service version
Description	It is the Description of the OData you have mention earlier
External Service Name	It is same to the auto generated service name
Namespace	It is by default bank
External Mapping ID	It is by default Empty
External Data Source Type	It is by Default set to source type C
Technical Model Name	It is auto generated Model Name
Model Version	It is auto generated Model Version
Package Assignment	Assign your package name here, or just choose Local Object from the button below. It will be then $TMP
ICF Node	It is by default “Standard Mode”
oAuth Enablement	It provides option to add extra authentication, in case you need oAuth2 enablement choose it, else leave it blank

 

In our case, we just need to choose package and click confirm, as shown below:

Once the service is registered, the Registration will turn green, as shown below:

Test the OData service

1. To test the OData service, click the SAP Gateway Client button, as shown below:
   
2. It will open a new screen, here click Add URI Option as shown below:
   
3. Choose $metadata, here:
   
4. Click Execute as shown below:
   

If the status is 200, as shown above, then it means your OData is working fine.

Steps to Register an OData service using /IWFND/MAINT_SERVICE

1. Open the Service Maintenance Screen using the transaction /IWFND/MAINT_SERVICE. The given screen will open:
   
2. Click “Add Service” button. It will open “Add Selective Services” popup.
   
3. Filter your service by entering it in the field “External Service Name” as shown below and click the search icon.
   
4. Now, the above search will return your OData Service name. Select your service and click Add Selected Service
   
5. Now, assign your package name to the Service as shown below. In case, you don’t have package name, either click on “Local Object” or write $TMP in the package assignment. Then, save the above settings.
   
6. Now, a pop up will open saying “Service <your service name> was created and its metadata was loaded successfully
7. Now, go back to the transaction /iwfnd/maint_service and filter your service again. This time select your service and select SAP Gateway client
   

The Filter will open this popup, enter your details here and click execute (the green button).

Then, follow these steps:

8. Here, test your service by following the steps given below:
   1. To test the OData service, click the SAP Gateway Client button, as shown below:
      
   2. It will open a new screen, here click Add URI Option as shown below:
      
   3. Choose $metadata, here:
      
   4. Click Execute as shown below:
      

If the status is 200, as shown above, then it means your OData is working fine.

Error Resolution

In case you get an error while testing. It might be due to the wrong configuration, or a few nodes are inactive.

To activate nodes, you need to visit T-Code SICF and search your service. Whatever result you will get, right-click on each and click “Activate”.

In case you are still getting the same error of Node Activation “Check the ICF nodes in Tx SICF: At least one node is inactive.”, that might be because your server doesn’t have HTTPS enabled. To configure that, you need to visit T-Code RZ10. Check these blogs for the same: Error Explanation, Error Resolution.

Tutorial Video

You can watch the below video to learn implementation:

[embedyt] https://youtu.be/2rEZrFj2haE?list=PLlZBMkVFeev4mdT2qpbUHTmZh4JMwrLqe&t=691[/embedyt]

Preface – This post is part of the SAP ABAP OData Tutorial series.

Introduction

In previous articles, we have discussed What is an OData and how to create an OData in SAP. We have also shown how to test an OData if it is working fine or not. Now, we need to learn how to read a table using an OData Query and also perform operations like Insert, Update and Delete on that table. In this article we will also learn basic queries of reading data.

How it works

In case of OData, there are three phases of data transfer. These are:

1. Sending Data from Frontend

Data is sent from UI (Client) to OData (Server) in form of query

2.      Taking Data from Frontend

At OData we receive data from Frontend using data provider (Code implemented in CRUD Operation section)

io_data_provider->read_entry_data(IMPORTING es_data= ls_entity).

3.      Sending Data to Frontend

From OData we send data to UI using et_entityset or er_entity after data manipulation (Code implemented in CRUD Operation section)

The above steps are shown in the image below:

Operations in ODATA

In this section, we will explore all the methods generated automatically, once you generate an OData. In last article, we have already instructed to write all your CRUD operations related code in DPC_EXT class. Hence, we will follow the same concept here.

SAP ABAP OData provides different methods for CRUD operations, these are:

Method	SQL Operation	Description
GET_ENTITY	Select	This method is used to read a single data based on table keys
GET_ENTITYSET	Select	This method is used to read entire data of a table
CREATE_ENTITY	Insert	This method is used to create/insert a new data in table
UPDATE_ENTITY	Update/Modify	This method is used to update an existing data in table
DELETE_ENTITY	Delete	This method is used to delete an existing data in table

 

Query in SAP OData

In this section, we will explore all the Query we can perform while reading data from OData. In above section, we have learnt how to do read calls using GET_ENTITY and GET_ENTITYSET. Sometimes, we need to filter out data according to our requirement, or to get total number of data counts or to get data in specific order. These all SAP OData Queries are explained below:
Here, let us suppose <your service name>  = https://isd.sap.com/<OData Service Name>

Query	Description	Example
$metadata	It gives the metadata detail of your service. By metadata we mean it will provide information about all the entity sets with their field names and their attributes	<your service name>/$metadata
$FILTER	It is mainly used during Read Entity Set call. During Read, we can send some filter value in backend that can be later used in where condition of Select queries	<your service name>/$FILTER
$top and $skip	It is mainly used to get limited data in the UI, in case you are reading all the data, and the table is having a very large data	<your service name>/$top and $skip
$orderby	This is used to order the data in ascending or descending order for a specific key	<your service name>/$orderby
$format=json	This returns the data in form of JSON format. By default, the result is in XML format.	<your service name>/$format=json
$inlinecount	This returns the number of data of a table that will appear in the UI	<your service name>/$inlinecount
$expand	This is used to bind the association and navigation data together	<your service name>/$expand
$value	This is used to return the media data	<your service name>/$value

Tutorial Video

You can watch the below video to learn implementation:

[embedyt] https://www.youtube.com/watch?v=2rEZrFj2haE[/embedyt]

Preface – This post is part of the SAP ABAP OData Tutorial series.

Introduction

In our previous article, we have already discussed what an OData is. In this article we will go through step by step process to create a SAP OData service. Later on, we will register our service and also test if it is working fine. In this article, we will not write any code related to CRUD (create, write, update and delete). To learn CRUD in OData, click here.

Step by Step Process to create SAP OData service

In this section we will follow multiple predefined steps to create an OData, these are:

1. We will use SAP Service Gateway Builder (SEGW) to create a new project
2. We will Import DDIC/CDS or other Structure to create an OData Model
3. We will Generate our OData
4. We will Register and test our Service

Create a new Service Builder project

To create a new project, follow the given steps:

1. Go to transaction code SEGW, it will start the Gateway Service Builder.
2. Click on the Create Project button, as shown below:
3. Enter the given information

Field	Description	Example
Project	It is the name of your SAP OData Service. It will start with Z or Y	ZPROJECT_NAME
Description	Enter a description for your OData	Demo OData Project
Project Type	SAP Provides given four Project Options: 1.       Service with SAP Annotations 2.       Service with Vocabulary-Based Annotations 3.       Annotation Model for Referenced Service 4.       OData 4.0 Service We will learn about them in details, later.	Service with SAP Annotations
Generation Strategy	It will be preloaded as Standard which means, it has all standard configurations.	Standard
Package	Enter your project package or temporary package i.e. $TMP	$TMP
Person Responsible	It will be preloaded with your User ID/ User Name	barryAllen

4. Press Continue and Save.

Import a DDIC structure

To use an OData Service, it should be designed in such way that it will read/update one or more table. Therefore, we need to import any table, structure or view. These are part of DDIC structure. We can also import Data model from file, RFC/ BOR Interface or a search help. But in this section, we will learn how to import a DDIC structure:

1. Click on the Data Model under the project we have recently created to expand it.
2. Right Click on Data Model and click Import and then click DDIC Structure
   
3. Now, a Wizard will open. Enter the following details, there:

Field	Description	Example
Name	Enter a name of Model. It should be explanatory.	CustomerData
Type	We have two options here: 1.       Entity Type: This means a simple DDIC structure/table/view will be imported 2.       Complex Type: This means a complex DDIC structure/table/view will be imported	Choose Entity Type
ABAP Structure	Choose your required table or structure name. Just copy and paste the name of your DDIC table/structure/view	zcustomer_data
Create Default Entity Set	It will create an Entity Type with the same fields as of Entity. Also, the name will remain same. We recommend you to leave it check marked.	Leave it check marked

 

The above details are shown below:

4. In the next step, the wizard will show all the fields of the imported table. Just select them all and click next as shown below:
   
5. In the next step, the wizard will show all the checked fields. Here you need to check the primary keys and finish, as shown below:
   

 

Generate OData Service

Now, we have created an OData object with a model. Now to use this Object we need to generate all the required classes. To generate, press the Generate Runtime Objects   button, as shown below:

Note: The Generate Runtime Objects button automatically saves the project before generating classes.

Pressing the above button, will open a dialog box as shown below:

Just press Continue, as shown above. The above process will generate following classes:

Class Name	Description
MPC Class	MPC stands for Model Provider Class. This is generated and refreshed every time, we generate a class. It is not recommended to extend this class for Model Annotations, because all the methods are deleted whenever the OData is generated.
MPC EXT Class	This is the Extended MPC class, and all the methods are conserved even the OData is generated.
DPC Class	DPC stands for Data Provider Class. This is generated and refreshed every time, we generate a class. It is not recommended to extend this class for CRUD operation, because all the methods are deleted whenever the OData is generated.
DPC EXT Class	This is the Extended DPC class, and all the methods are conserved even the OData is generated.
MDL Class	The is the Model Class.
SRV Class	This is the Service Class.

 

Just click on Lock Object to generate the classes, as shown below:

Register SAP OData using the Gateway client

Once the OData is generated, now it is the time to register the service. Once the service is registered, then only it can be used anywhere.

To generate an OData, follow the given steps:

1. Double click the node Service Maintenance
2. Select any System and click Register as shown below:
   
3. Enter an Alias, if asked as shown below:
   
4. Now, in the next screen you get following options:

Field	Description
Technical Service Name	This is auto generated service name
Service Version	It is auto generated service version
Description	It is the Description of the OData you have mention earlier
External Service Name	It is same to the auto generated service name
Namespace	It is by default bank
External Mapping ID	It is by default Empty
External Data Source Type	It is by Default set to source type C
Technical Model Name	It is auto generated Model Name
Model Version	It is auto generated Model Version
Package Assignment	Assign your package name here, or just choose Local Object from the button below. It will be then $TMP
ICF Node	It is by default “Standard Mode”
oAuth Enablement	It provides option to add extra authentication, in case you need oAuth2 enablement choose it, else leave it blank

 

In our case, we just need to choose package and click confirm, as shown below:

Once the service is registered, the Registration will turn green, as shown below:

Test the OData service

1. To test the OData service, click the SAP Gateway Client button, as shown below:
2. It will open a new screen, here click Add URI Option as shown below:
   
3. Choose $metadata, here:
   
4. Click Execute as shown below:
   

If the status is 200, as shown above, then it means your OData is working fine.

In upcoming articles, we will learn how to perform CRUD operation using OData.

Tutorial Video

You can watch the below video to learn implementation:

[embedyt] https://www.youtube.com/watch?v=2rEZrFj2haE[/embedyt]