Expose CDS Views as OData Service
In continuation to previous blog Core Data Services in ABAP in this blog I will show how to create CDS Views and step by step procedure to generate OData service using CDS Views.
There are 3 different ways you can expose CDS views as OData service:
- Import DDIC structure using SEGW Netweaver Gateway service builder transaction.
- Reference Data Source using SEGW Netweaver Gateway service builder transaction.
- Using Generic Annotations. (@Odata.publish:true)
First way is supported from SAP ABAP NW 7.40 SP5, Second and third ways are supported from SAP ABAP NW 7.50 and above. For first two ways SAP NW Gateway is used and for third type without use of SAP NW Gateway odata services can be created using annotations. Gateway is used only to add the service created using annotations.
In this blog I am going to show type one i.e how to generate OData service using import DDIC structure using SEGW service builder transaction.
How to Create CDS View:
Firstly as a prerequisite ABAP Development tools(ADT) needs to be installed in Eclipse to create CDS Views.
On installation of ADT in eclipse open ABAP perspective as shown below:
After opening ABAP perspective, In project explorer right click in the context menu select New->ABAP Project. A popup appears asks for ABAP system details which you need to add to create CDS views. Details like System-ID, Username, Password has to be given and click on OK to add the system to eclipse. Note that ABAP system which you add should support SAP ABAP NW 7.40 package. find the attachment for how to add ABAP system to eclipse.
Once after adding the ABAP system project explorer looks like below:
Expand $TMP package, Select and right click on Dictionary folder in the context menu to create DDL source ABAP Repository Object
Select DDL source, click on next and give below details to create sample CDS view:
Without clicking on finish, on click on next CDS view ask for transport:
since CDS view is create in local object no transport is required, click on next then sample templates are populated to select:
You can use any of the template as shown above to create CDS view. Template helps you to create different types of CDS views with syntax auto populated on selecting the type of view. Here I am creating simple CDS view so I select define view template and click on finish.
In the define view template core annotations are populated with basic syntax to create view, define the view as below:
Here I defined sql view name as ‘CDS_DDL_SAMPLE1’ and selected data from “snwd_so” sales order data source with some columns. After defining the view, Activate the view as shown above. On Activation two objects are created:
1. CDS Database View (CDS_DDL_SAMPLE1)
2. CDS entity. (ZCDS_SAMPLE1)
CDS Database view can be accessed using SE11 ABAP Dictionary as shown below:
Give CDS Database View name as shown above and click on display.
DDL SQL view is created in ABAP Dictionary. Here you can identify MANDT field in the view definition though we didnt mention it explicitly while defining the view. CDS views are default client dependent no need to mention client field while defining the view.
Right click on CDS View created to preview the data as shown below:
Generate OData service using CDS View:
Go to SEGW transaction. Create project as shown below:
Give project details as below:
Save project in local object. Expand project node, right click on data model->import->DDIC structure:
Create entity type by importing ABAP structure. Here give CDS Dabase view ‘CDS_DDL_SAMPLE1’, select create default entity set flag and click on next:
follow the wizard where you select parameters and key fields respectively:
click on finish, then entity, entity set and corresponding properties are created. Expand node service implementation right click on SalesOrderSet->Map to Data Source
Here you map your CDS Database view(CDS_DDL_SAMPLE1) and CDS enity(ZCDS_SAMPLE1). on click on map to data source popup populates to select CDS business entity:
select type as business entity and give CDS entity ZCDS_SAMPLE1 as Name:
click on OK.
click on OK. Drag and drop properties to map fields or click on generate mapping to automatically map the fields.
In model and service definition you can find DPC, MPC classes and technical service name of odata service:
click on ok and save the objects in local object;
after saving run time artifacts are generated. Expand node Service maintenance select gateway, click on register button to register the service.
add the service to local object:
click on OK. Now service is registered you can find status as green as shown below and click on Gateway client button to access the service:
Odata service in gateway client:
Use OData parameter $metadata to view the metadata of service:
on using odata parameter $metadata you can find the properties and entities of CDS view exposed as odata service.
This is how you create CDS view and expose the same as odata service using import DDIC structure by mapping CDS Database View and CDS entity using SEGW service builder transaction.
Hope you find this blog helpful.
In my next blogs I will try to touch other ways to expose cds view as odata service.
Your suggestions, feedback, comments on this blog are most welcome.
Few Useful links:
Note: This is my previous SCN for the new and latest blogs please follow my new SCN blog https://people.sap.com/reddypavankumar