7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Products
Products Industries
Industries Support
Support Training
Training Community
Community Developer
Developer Partner
Partner

About
About

Home / Community / Blogs + Actions

Creating an ODATA Service for Smart Tables

Part 1
October 19, 2015 | 2,387 Views |

Florian Hafner
more by this author

SAPUI5

SAP Enterprise Portal | annotations | gateway | odata | sapui5 | smarttable

share
0 share
0 tweet share
0

Follow

Introduction

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 1/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

The Problem
The Solution

Creating the ODATA Service

Creating the Annotation Model
Extending the Annotation Model

Introduction

Over the last week i spent a vast amount of time playing around with the
Smart Table Control and trying to generate an ODATA Service in our Gateway
Backend delivering the needed Annotations for this Control.

After endless hours of trial and error and analyzing the Smart Table Example
in the Explored App

https://sapui5.hana.ondemand.com/explored.html#/sample/sap.ui.comp.sampl
e.smarttable/preview

i finally managed to get the needed Annotations like the LineItem for setting
default Columns delivered by our Gateway.

In this Blog i will share my Experience with this and show the method i used to
maybe save others this time consuming task of trial.

The only Requirement for this to work is that you are using SAPUI5 Version
1.30.3 or above as they fixed the parsing of Collections and Records for
Annotations in this Version which is neccesary for this to work properly.

In this Part of the Blog we will look on how to implement the ODATA Service in
the Backend Gatway System.

The Problem

The Smart Table Control requires not only the Standard SAP Annotations like
creatable, filterable etc. but also the use of ODATA Annotation which are
supported by Netweaver Gateway for a while now. The Problem is in the
current state of the Gateway Service Builder Transaction you could choose to

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 2/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

either use the SAP or the ODATA Annotations not both of them at the same
time.

The Solution

By utilizing the possibility to create seperate Annotation Models to enrich the

Standard Service with SAP Annotations with the needed ODATA Annotations
and linking the ODATA Model on the Clientside with the Annotation Model you
will be able to use both Annotation Types. However this requires some manual
Coding as the Service Builder by now is not able to generate the needed
Annotations (as far as i know).

This requires some steps which i will explain in the following sections.

Creating the ODATA Service

To deliver some Data to actually display in the Smart Table we need to create
an basic ODATA Service. For this Service i used the BAPI
BAPI_CUSTOMER_GETLIST to get a List of Customers to display in the
Table.

Be sure to select Service with SAP Annotation for the Project Type.

Im not going into Details here about creating the mapping and this stuff as
this should be relatively well documented by now.

Just get sure you are checking some of the Entity Properties as filterable to
enable the Filtering for these in the Smart Table.
https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 3/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

After setting up the Service generate the Runtime Artifacts.

Creating the Annotation Model

To enrich the previous Service with the additional Annotations, for example the
LineItem for the default Columns we need to create an Annotation Model.

In Service Builder create a new Project of Type Annotationmodel for

referenced Service.

Then open this Project in Edit Mode and right Click on the Data Model, select
Import and Servicereference

In the Popup select the Service you want to annotate. This will import the Data
Model into your Annotation Model.

Then do the same again but this time select Vocabulary and import the
Vocabularies you want to use.

You can now generate the Annotation Model for the Service as from now on
the Gateway Builder will not be able to generate the needed Changes.
https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 4/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Extending the Annotation Model

Generating the Runtime Artifacts for the Annotation Model will generate an
Extension Class (ZCL_MODELNAME__01_APC_EXT) for you.

Open this Class go to the Methods, select the Method

DEFINE_VOCAB_ANNOTATIONS and click on redefine.

In the Redefinition of this Method we want to implement the Annotation for the
LineItem Collection for the Smart Table like this:

METHOD define_vocab_annotations.
*Data Declaration
DATA: lo_ann_target TYPE REF TO /iwbep/if_mgw_vocan_ann_target.
DATA: lo_annotation TYPE REF TO /iwbep/if_mgw_vocan_annotation.
DATA: lo_collection TYPE REF TO /iwbep/if_mgw_vocan_collection.
DATA: lo_function TYPE REF TO /iwbep/if_mgw_vocan_function.
DATA: lo_fun_param TYPE REF TO /iwbep/if_mgw_vocan_fun_param.
DATA: lo_property TYPE REF TO /iwbep/if_mgw_vocan_property.
DATA: lo_record TYPE REF TO /iwbep/if_mgw_vocan_record.
DATA: lo_simp_value TYPE REF TO /iwbep/if_mgw_vocan_simple_val.
DATA: lo_url TYPE REF TO /iwbep/if_mgw_vocan_url.
DATA: lo_label_elem TYPE REF TO /iwbep/if_mgw_vocan_label_elem.
DATA: lo_reference TYPE REF TO /iwbep/if_mgw_vocan_reference.
*Calling the generated mehtod for creating annotations
CALL METHOD super->define_vocab_annotations( ).
*Creating the references for the vocabularies
lo_reference = vocab_anno_model->create_vocabulary_reference( iv_vocab_id = '/IWBEP/VOC_CAPABILITIES'
iv_vocab_version = '0001').
lo_reference->create_include( iv_namespace = 'Org.OData.Capabilities.V1' ).
lo_reference = vocab_anno_model->create_vocabulary_reference( iv_vocab_id = '/IWBEP/VOC_CORE'
iv_vocab_version = '0001').
lo_reference->create_include( iv_namespace = 'Org.OData.Core.V1' ).
lo_reference = vocab_anno_model->create_vocabulary_reference( iv_vocab_id = '/IWBEP/VOC_COMMON'
iv_vocab_version = '0001').
lo_reference->create_include( iv_namespace = 'com.sap.vocabularies.Common.v1' ).
lo_reference = vocab_anno_model->create_vocabulary_reference( iv_vocab_id = '/IWBEP/VOC_COMMUNICATION'
iv_vocab_version = '0001').
lo_reference->create_include( iv_namespace = 'com.sap.vocabularies.Communication.v1' ).
lo_reference = vocab_anno_model->create_vocabulary_reference( iv_vocab_id = '/IWBEP/VOC_MEASURES'
iv_vocab_version = '0001').
lo_reference->create_include( iv_namespace = 'Org.OData.Measures.V1' ).
lo_reference = vocab_anno_model->create_vocabulary_reference( iv_vocab_id = '/IWBEP/VOC_UI'
iv_vocab_version = '0001').
lo_reference->create_include( iv_namespace = 'com.sap.vocabularies.UI.v1' ).
*Creating the Annotation Target
lo_ann_target = vocab_anno_model->create_annotations_target( iv_target = 'ZCUSTOMER_SRV.Addressdata' ).
*Creating the LineItem Collection
lo_annotation = lo_ann_target->create_annotation( iv_term = 'com.sap.vocabularies.UI.v1.LineItem' ).
lo_collection = lo_annotation->create_collection( ).
*Creating the Records
lo_record = lo_collection->create_record( iv_record_type = 'com.sap.vocabularies.UI.v1.DataField' ).
lo_property = lo_record->create_property( iv_property_name = 'Value').

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 5/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

lo_simp_value = lo_property->create_simple_value( ).
lo_simp_value->set_path( 'Customer' ).
lo_property = lo_record->create_property( iv_property_name = 'Label').
lo_simp_value = lo_property->create_simple_value( ).
lo_simp_value->set_string( 'Kunde' ).
*
lo_record = lo_collection->create_record( iv_record_type = 'com.sap.vocabularies.UI.v1.DataField' ).
lo_property = lo_record->create_property( iv_property_name = 'Value').
lo_simp_value = lo_property->create_simple_value( ).
lo_simp_value->set_path( 'Country' ).
lo_property = lo_record->create_property( iv_property_name = 'Label').
lo_simp_value = lo_property->create_simple_value( ).
lo_simp_value->set_string( 'Land' ).
*
lo_record = lo_collection->create_record( iv_record_type = 'com.sap.vocabularies.UI.v1.DataField' ).
lo_property = lo_record->create_property( iv_property_name = 'Value').
lo_simp_value = lo_property->create_simple_value( ).
lo_simp_value->set_path( 'Name' ).
lo_property = lo_record->create_property( iv_property_name = 'Label').
lo_simp_value = lo_property->create_simple_value( ).
lo_simp_value->set_string( 'Name' ).
*
ENDMETHOD.

In Line 36 we are creating an Annotation for our Entity (i called it Adressdata).

You must set the target with the Pattern ServiceNamespace.Entity. You can
find this Namespace in your Service Metadata Definition.

We are then creating an Annotation for the LineItem and add a Collection to it.
In the Collection Records you can then set your Default Columns.

The Path in the Value Property must correspond to one of your Entity
Properties while the Label can be anything you want (this is the Text which is
shown in the Table as Column Title).

Activate this Class and we are done with the Backend Coding.

You can verify that everything went smoothly by calling your Annotation Model
in the Gateway Client with the URL:

/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName=
YOURMODELNAME_MDL,Version=0001)/$value

You should see the Annotations we made on the bottom of the Response.

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 6/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

In the next Part we will look on the Coding required on the SAPUI5 Application
to tell the Smart Table about the created Annotation Model.

Regards,

Florian

Alert Moderator

17 Comments
You must be Logged on to comment or reply to a post.

Florian Kruse

October 22, 2015 at 1:34 pm

Hi Florian,
I have eactly this problem when trying to set up a SmartTable. The popup at the
beginning
telling me to select coloumns first is very annoying.
So i was very happy to find your post exactly on this.
But there is one problem for me. I followed your instructions step by step and even
checked my existing OData Service if its suitable for this.
Everything went well, but when i am trying to test my annotations using your link i get the
following error:

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 7/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Keine Vokabularannotationsdatei fr ID SERVICE_MODEL_NAME, Version

0001, gefunden

Everything is activated and saved. Do you have any further ideas on this?
Greetings from Bielefeld,
Florian Kruse

Florian Hafner Post author

October 22, 2015 at 2:57 pm

Hello Florian,
I noticed this problem too but as of now its gone for me. But basically you
can just throw the Coding into your MPC_EXT Class of your Service and it
should work too. You just loose this nice Separation between
Servicedefinition and Annotationdefinition (its very cool in my opinion as
you can just generate many different Annotations fo a single service if you
need to).
Regards,
Florian

Arshad Ansary

November 2, 2015 at 8:11 am

Hi Florian
I am getting Select atleast one column to search in my UI5
application even though I have filled LineItem annotation
property for my entity type
Is there anything I am missing here ?

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 8/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Florian Hafner Post author

November 2, 2015 at 8:24 am

Hello Arshad,
If you are using a separate Annotation File you
have to set the property annotationURI of your
oData Model to the Annotation File.
I wanted to point this out in Part 2 but didnt had
the time since to do so.
Regards
Florian

Arshad Ansary

November 2, 2015 at 8:37 am

Hi Florian,
Thanks for you answer
I am setting the same .But I am still getting the
same error

Florian Hafner Post author

November 2, 2015 at 8:49 am

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 9/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Hello Arshad,
Can you try it like this:
var sServiceUrl = yourServiceUrl;
var oConfig = {
metadataUrlParams: {},
json: true,
annotationURI:
yourAnnotationModelUrl,
loadAnnotationsJoined : true,
defaultBindingMode: TwoWay,
defaultCountMode: Inline,
useBatch: true
};
var oModel = new
sap.ui.model.odata.v2.ODataModel(
sServiceUrl, oConfig);
This worked for me.
You can verify that the Annotations
are loaded by calling the Model in
Debugger and look at the
oAnnotations Property.
It should look similar to this:

Edit: And i guess you have an Error

in your LineItem Annotation you
need 2 Propertys per Record.
One with
Path=yourServiceProperty and
Property=Value and another one
with String=anyCustomName and
Property=Label.
Look at my ABAP Coding Lines 40-
47.
There im creating two 2 Propertys
for the Customer Record. One is the
Reference to the actual Entity

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 10/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Property and the other is a Custom

Label which is shown in your table.
Regards,
Florian

Arshad Ansary

November 12, 2015 at 8:17 am

Thanks Florian . It solved the issue

Regards
Arshad

Marcos Andrade

November 26, 2015 at 5:22 pm

Hello Florian,
I had the same problem and realized that I havent Activate the Odata
Service in the transaction /IWFND/MAINT_SERVICE
after that it worked.
Regards,
Marcos

Tejas S. Gargeya Sastry

January 6, 2016 at 4:39 pm

Hi Florian,
I have mentioned the oConfig properly and the annotations
load properly on the SAPGateway Client. However, it just
doesnt load when called from the UI.
oAnnotations: E.extend.constructor
bAsync: true
bLoaded: false
bValidXML: true
mEventRegistry: Object
oAnnotations: Object

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 11/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

oError: null
oFailedEvent: null
oLoadEvent: null
oMetadata: Object
oRequestHandles: Array[0]
xPath: null
__proto__: d

Any thoughts as to why this might be happening? Looking

forward to your response. Thank you.

Regards,
Tejas.

Florian Hafner Post author

January 7, 2016 at 9:32 am

Hello Tejas,
Can you expand the inner oAnnotations Object
pls?
Your Annotations should be inside this Object.
Regards,
Florian

Sashko Janev

November 9, 2015 at 4:21 pm

Hi Florian,
I have created the oData service as you did, but when I try to create the annotation
reference model i only see 2 options:

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 12/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

And Im guessing you are using another option, right?

Am I missing some step in configuration?

Florian Hafner Post author

November 10, 2015 at 6:52 am

Hello Sashko,
yes you should see a third option there.
Maybe you have to update your SAP_GWFND Component.
I guess the SEGW is part of the Gateway Component.
What is your patchlevel there?
but as stated in the response for Florian you could also slap the annotations
inside your model definition in your mpc_ext Class of your service.
Regards
Florian

Sashko Janev

November 10, 2015 at 9:12 am

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 13/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

I think its the latest version:

About the code you mentioned, where should I insert it,

because i dont have that method that you talk about in the
tutorial. Should I create a new one or put it in some of the
existing methods:

Thanks.

Florian Hafner Post author

November 10, 2015 at 9:26 am

Hello Sashko,
Inside the DEFINE Method you should see the
definition of your Model Entitys and Property.
When you redefine this Method you can add the
Code there.
The Method DEFINE_VOCAB_ANNOTATIONS is
a generated Method for the Annotation Classes
which you will not get because you are extending

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 14/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

a basic ODATA Service and not a Annotation

Service.
Here is a example:

Regards,
Florian

Beat Birrer

February 15, 2016 at 2:11 pm

Hi Florian,
where can I find the next part (part2) of your tutorial?
Thanks for your help.
Regards,
Beat

meghal shah

March 16, 2016 at 12:27 pm

Hi Florian,
where can I find the next part (part2) of your tutorial?
Thanks for your help.
Regards,
Meghal Shah

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 15/16
7/23/2017 Creating an ODATA Service for Smart Tables Part 1 | SAP Blogs

Heidrun Meisel

May 5, 2017 at 1:15 pm

Hi Florian,
I have a problem using this reference service in UI5 because there is not really an
external serice with this name and if I try to create it, I get the message that there is no
backend service. SEGM shows me the definition of the original service for the reference
service too. Would it be possible to explain how this reference service can be used for
smart tables? A comination of the original service and the reference annotation model
did also not solve my problem with missing metadata information concerning initially
used columns.
Regards,
Heidrun Meisel

Share & Follow

Privacy Terms of Use Legal Disclosure Copyright Trademark Sitemap Newsletter

https://blogs.sap.com/2015/10/19/creating-an-odata-service-for-smart-tables/ 16/16