Manual de ODATA

Manual de ODATA





¿Qué es ODATA? El protocolo Open Data (OData) le permite tener acceso a un origen de datos, como una base de datos a través de una dirección URL construida especialmente. Esto permite un enfoque simplificado para conectarse y trabajar con orígenes de datos hospedados en una organización. OData es un protocolo que usa HTTP, Atom y Notación de objetos de JavaScript (JSON) que permiten a los desarrolladores escribir aplicaciones que se comunican con un número creciente de orígenes de datos. Microsoft admite la creación de este estándar como una forma de habilitar el intercambio de datos entre las aplicaciones y los almacenes de datos accesibles desde la web. ¿Cómo crear un proyecto ODATA en SAP? Pasos: ’ 1. Ingresar a la transacción SEGW y presionar el botón ‘Create Project ’

Elaborado por: Ruddy Enzo Reátegui Macedo

2. Ingresamos los datos necesarios para crear nuestro proyecto como objeto local y aceptamos

El proyecto ZSFLIGHT_PROYECTO se visualiza de la siguiente manera:


2. Ingresamos los datos necesarios para crear nuestro proyecto como objeto local y aceptamos

El proyecto ZSFLIGHT_PROYECTO se visualiza de la siguiente manera:


’ que 3. Para hacer completo este ejemplo vamos a crear un Entity Type llamado ‘Carrier ’ tendrá como referencia la tabla ‘SCARR’ , con la finalidad de servir de estructura estructura para mostrar los registros de las Aerolíneas. Data Model ’ ’, y seleccionar ‘Import>DDIC Structure’ Clic derecho en ‘ Data

Ingresar el nombre del tipo de entidad y de la estructura del diccionario ABAP que vamos a usar, para este caso es la tabla SCARR. Dejar marcado marcado la opción ‘Create Default Entity Set’ que ’. que luego lo usaremos y presionar el botón ‘Next ’


Seleccionamos los campos de la estructura SCARR que necesitamos, a modo de ’ y ejemplo seleccionaremos todos los campos a excepción de ‘Mandt ’ y presionamos el Next ’ ’. botón ‘ Next


CARRID’ como inish’ . Marcamos el campo ‘CARRID’ como campo clave y presionamos el botón ‘F inish’

Así se visualiza nuestro Entity Type ‘ Carrier Carrier ’ ’

Tener en cuenta que se puede cambiar los nombres de cualquiera de las propiedades


4. Modificar nombre de Entity Sets ‘CarrierSet ’ creado por defecto a ‘Carrier ’ Nos vamos a Entity Sets y hacemos doble click en ‘CarrierSet ’

Modificamos el nombre del Entity Set ‘ CarrierSet ’ por ‘Carriers’ , para luego acceder desde el navegador y obtener los registros de las aerolíneas.


5. Generamos el servicio ODATA. Nos posicionamos el nombre del proyecto y presionamos el botón ‘Generate Runtime Objects’ .


Presionamos el botón Aceptar y lo guardamos como objeto local. Tener en cuenta que necesitaremos el nombre del servicio ZSFLIGHT_PROYECTO_SRV para acceder desde la web.


Así se visualiza el log después de haber generado el servicio.


6. Activando el servicio ODATA Nos dirigimos a la transacción /IWFND/MAINT_SERVICE y hacemos clic en ‘Add Service’

Buscamos nuestro servicio con valor ‘System Alias’ = LOCAL porque el proyecto fue grabado como objeto local y presionamos el botón ‘Get Services’ .


Buscamos nuestro servicio en el listado mostrado y presionamos el botón ‘Add Selected Services’


En la siguiente ventana presionamos el botón ‘Aceptar’


7. Ahora vamos a modificar el ‘GetEntitySet (Query)’ del Service Implentation ‘Carriers’ para obtener los registros de la tabla SCARR Nos dirigimos al GetEntitySet (Query)’ de Carriers


Ahora hacemos clic derecho en ‘ GetEntitySet (Query)’ de Carriers y no dirigimos a ‘Go to ABAP Workbench’

Se mostrará un mensaje popup indicando que el método aún no ha sido implementado, presionamos el botón ‘Aceptar’


Se muestra la siguiente visualización.

Nos posicionamos en ‘CARRIERS_GET_ENTITYSET’ , le damos clic derecho y hacemos clic en ‘Redefine’


Agregamos el siguiente código para obtener los registros de las aerolíneas de la tabla SCARR SELECT * from scarr into CORRESPONDING FIELDS OF TABLE ET_ENTITY SET.

8. Ahora vamos a testear el método CARRIERS_GET_ENTITYSET’ desde la Web. Nos dirigimos a la transacción /IWFND/MAINT_SERVICE y ubicamos nuestro servicio ODATA registrado. Presionamos el botón ‘Call Browser ’

Se muestra la siguiente pantalla en el navegador Web


Cambiamos el enlace: http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/?$f ormat=xml Por http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/Car riers para poder obtener los registros de la tabla SCARR, ya que al llamar a Carriers hará que ingresé al método ‘CARRIERS_GET_ENTITYSET’ que hemos implementado.


Para poder tener una mejor vista de los registros vamos a utilizar la terminación ?$format=json&sap-ds-debug=true en el enlace, de la siguiente manera: http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/Car riers?$format=json&sap-ds-debug=true


9. Ahora vamos a modifica el el ‘GetEntity (Read)’ del Service Implentation ‘Carriers’ para obtener un solo registro en base a la llave ‘ Carrid ’ Nos dirigimos al GetEntity (Read)’ de Carriers. Ahora hacemos clic derecho en ‘GetEntity (Read)’ de Carriers y no dirigimos a ‘Go to ABAP Workbench’

Se mostrará un mensaje popup indicando que el método aún no ha sido implementado, presionamos el botón ‘Aceptar’



Nos posicionamos en ‘CARRIERS_GET_ENTITY’ , le damos clic derecho y hacemos clic en ‘Redefine’


Agregamos el siguiente código para obtener el registro de la aerolínea de la tabla SCARR en base al código ‘C arrid ’ data: ls_key like line of it_key_tab, ldt_scarr TYPE STANDARD TABLE OF scarr, lwa_scarr like LINE OF ldt_scarr. read table it_key_tab into ls_key with key name = 'Carrid'. * If there is a carrier ID specified, use it to select only tho se for the specific carrier if sy-subrc eq 0. SELECT * from scarr into CORRESPONDING FIELDS OF TABLE ldt_scarr WHERE carrid EQ ls_key-VALUE.

IF LDT_SCARR is NOT INITIAL. READ TABLE LDT_SCARR into LWA_SCARR INDEX 1. MOVE-CORRESPONDING LWA_SCARR to ER_ENTITY. ENDIF. endif.

10. Ahora vamos a testear el método CARRIERS_GET_ENTITY’ desde la Web. Nos dirigimos a la transacción /IWFND/MAINT_SERVICE y ubicamos nuestro servicio ODATA registrado. Presionamos el botón ‘Call Browser’


Se muestra la siguiente pantalla en el navegador Web

Cambiamos el enlace: http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/?$f ormat=xml Por http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/Car riers(‘AA’)?$format=json&sa p-ds-debug=true para poder obtener el registro de la tabla SCARR que tenga el código ‘Carrid’ = ‘AA’ , ya que al llamar a Carriers(‘AA’) hará que ingresé al método ‘ CARRIERS_GET_ENTITY ’ que hemos implementado y no al método CARRIERS_GET_ENTITYSET’ .




¿Cómo crear asociaciones ODATA? Para este ejemplo vamos a usar todo lo desarrollado anteriormente, el propósito de este ejercicio es crear asociaciones entre dos entidades e implementar el método Get EntitySet(Query). Para este ejercicio vamos a usar todo lo desarrollado anteriormente, vamos a crear un Entity Type más denominado Sflight para crear una relación con Carrier (Aerolíneas), el propósito de este ejercicio es enviar los vuelos (Sflight) de una determinada aerolínea (Carrier). Pasos: 1. Vamos a crear un Entity Type llamado Sflight, clic derecho en ‘Data Model’ , y seleccionar ‘Import>DDIC Structure’.


Ingresar el nombre del tipo de entidad y de la estructura del diccionario ABAP que vamos a usar, para este caso es la tabla SFLIGHT. Dejar marcado la opción ‘Create Default Entity Set’ que luego lo usaremos y presionar el botón ‘ Next’ .


Seleccionamos los campos de la estructura SFLIGHT que necesitamos, a modo de ejemplo seleccionaremos todos los campos a excepción de ‘Mandt’ y presionamos el botón ‘Next’ .

Marcamos el campo ‘CARRID’ como campo clave y presionamos el botón ‘Finish’ .


Así se visualiza nuestro Entity Type ‘Sflight’

Tener en cuenta que se puede cambiar los nombres de cualquiera de las propiedades 2. Modificar nombre de Entity Sets ‘ FlightSet’ ,creado por defecto, a ‘Flights’ Nos vamos a Entity Sets y hacemos doble click en ‘FlightSet’


Modificamos el nombre del Entity Set ‘FlightSet’ por ‘Flights’ , para luego acceder desde el navegador.


3. Vamos a crear la navegación de Carriers a Flights denominado ‘ FlightsToCarriersAsoc’ para relacionar la entidad (1)Carrier con (N)Flight . Nos dirigimos a ‘Associations’ , clic derecho en ‘Create’ .


Procedemos a ingresar los detalles de nuestra asociación de Flights a Carriers. Tener en cuenta que la entidad principal es Carrier (Aerolínea), luego presionamos el botón ‘Next’ .


Luego relacionamos los campos claves de ambas entidades, para este caso es el campo ‘Carrid’. Clic en ‘Next’


Por último clic en ‘Finalizar’ para terminar con el paso de crear la asociación de las entidades.

Así se visualiza la asociación creada


Además se creó la Navigation Properties ‘Flight sToCarriers’ del Entity Type ‘Carrier’


4. Ahora vamos implementar el métodos Get EntitySet(Query) de la entidad Flight que está vinculado con la entidad Carrier para obtener sus registros relacionados. No dirigimos a ‘Service Implementation>Carriers>Get Entity Set (Query )’ , click derecho en ‘Get Entity Set (Query )’ y elegimos la opción ‘Go to ABAP Workbench’


En la siguiente pantalla nos posicionamos en ‘Methods>Inherited Methods>Flights_Get_EntitySet ’, hacemos clic derecho y elegimos la opción ‘Redefine’


Implementamos el siguiente código para obtener un registro de la entidad Flight (Vuelo) que está relacionado con la entidad Carrier (Aerolínea) en base a una determinada aerolínea (Carrid). data: ls_key like line of it_key_tab. read table it_key_tab into ls_key with key name = 'Carrid'. * If there is a carrier ID specified, use it to select only tho se for the specific carrier if sy-subrc eq 0. select * from sflight into corresponding fields of table et_ entityset where carrid = ls_key-value. * If there is no carrier specified, read all the flights else. select * from sflight into corresponding fields of table et_ entityset. endif.


5. Para testear la conexión ingresemos al siguiente link: http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/Car riers('AA')/FlightsToCarriers?$format=xml Dónde ‘FlightsToCarriers’ es la propiedad de navegación de la entidad Carrier. La siguiente imagen muestra los registros para la entidad Flight en base al código de aerolínea (Carrier).




¿Cómo implementar Expand Entity/Entity Set? Para este ejercicio vamos a usar todo lo desarrollado anteriormente, vamos a crear un Entity Type más denominado Sflight para crear una relación con Carrier (Aerolíneas), el propósito de este ejercicio es enviar datos de dos tablas relacionadas. Pasos: 1. Vamos a crear la navegación de Carriers a Flights denominado ‘VuelosDeAerolineaAsoc’ para obtener de una aerolínea específica todos sus vuelos. Nos dirigimos a ‘Associations’ , clic derecho en ‘Create’


Procedemos a ingresar los detalles de nuestra asociación de Flights a Carriers. Tener en cuenta que la entidad principal es Carrier (Aerolínea), luego presionamos el botón ‘Next’ .


Luego relacionamos los campos claves de ambas entidades, para este caso es el campo ‘Carrid’. Clic en ‘Next’


Por último clic en ‘Finalizar’ para terminar con el paso de crear la asociación de las entidades.

Así se visualiza la asociación creada


Además se creó la Navigation Properties ‘VuelosDeAerolinea’ del Entity Type ‘Carrier’


2. Ahora vamos a implementar el método ‘ GET_EXPANDED_ENTITY ’ para obtener los vuelos de una determinada aerolínea. Nos dirigimos a ‘Runtime Artifacts’ , nos posicionamos en ZCL_ZSFLIGHT_PROYECTO_DPC_EXT. Clic derecho en la clase y elegimos la opción ‘Go to ABAP Workbench’



Necesitamos redefinir el método /IWBEP/IF_MGW_APPL_SRV_RUNTIME~GET_EXPANDED_ENTITY, para ello nos dirigimos a ‘Methods>Inherited Methods> /IWBEP/IF_MGW_APPL_SRV_RUNTIME/GET_EXPANDED_ENTITY’ . Clic derecho y elegir la opción ‘Redefine’ .


Agregamos el siguiente código para obtener los vuelos de una determinada aerolínea. TYPES: ty_flight TYPE STANDARD TABLE OF ZCL_ZSFLIGHT_PROYECTO _MPC=>TS_FLIGHT WITH DEFAULT KEY. TYPES: BEGIN OF ty_carrier. INCLUDE TYPE ZCL_ZSFLIGHT_PROYECTO_MPC=>TS_C ARRIER. types: vuelosdeaerolinea type ty_flight, END OF ty_carrier. DATA:

ls_key_tab lv_carrid

TYPE /iwbep/s_mgw_name_value_pair, TYPE scarr-carrid.

DATA: ltd_flight TYPE ZCL_ZSFLIGHT_PROYECTO_MPC=>TT_FLIGHT, lwa_flight like LINE OF ltd_flight, lwa_carrier TYPE ty_carrier. DATA: lwa_carrier2 TYPE scarr, ltd_flight2 TYPE STANDARD TABLE OF sflight.

CONSTANTS: lc_expand_tech_clause EROLINEA'.

TYPE string VALUE 'VUELOSDEA

*Get the key property values and Read Sales Order and Item data READ TABLE it_key_tab WITH KEY name = 'Carrid' INTO ls_key_tab . IF sy-subrc = 0.

lv_carrid = ls_key_tab-value. SELECT SINGLE * from scarr into lwa_carrier2 WHERE carrid EQ lv_carrid. IF lwa_carrier2 is NOT INITIAL. SELECT * from sflight into CORRESPONDING FIELDS OF TABLE ltd_flight WHERE carrid EQ lv_carrid. IF ltd_flight[] is not INITIAL. MOVE-CORRESPONDING lwa_carrier2 to lwa_carrier. lwa_carrier-VUELOSDEAEROLINEA = ltd_flight[]. ENDIF. ENDIF. ENDIF. * Fill ER_ENTITY


copy_data_to_ref( EXPORTING is_data = lwa_carrier CHANGING cr_data = er_entity ). * Insert Navigation property into ET_EXPANDED_TECH_CLAUSES INSERT lc_expand_tech_clause INTO TABLE et_expanded_tech_claus es.

Con este paso estaríamos finalizando la implementación del método /IWBEP/IF_MGW_APPL_SRV_RUNTIME~GET_EXPANDED_ENTITY. 3. Testearemos el Expand Entity implementado con el siguiente enlace: http://psaperp02.xternal.biz:8000/sap/opu/odata/sap/ZSFLIGHT_PROYECTO_SRV/Car riers('AA')?$expand=VuelosDeAerolinea&$format=json&sap-ds-debug=true Notemos que se está mostrando la aerolínea ‘AA’ con sus respectivos vuelos. Esta sería la forma de obtener tabla cabecera con su detalle en base a un parámetro.


4. Ahora vamos a implementar el método ‘GET_EXPANDED_ENTITY SET ’ para obtener las aerolíneas con sus vuelos. Nos dirigimos a ‘Runtime Artifacts’ , nos posicionamos en ZCL_ZSFLIGHT_PROYECTO_DPC_EXT. Clic derecho en la clase y elegimos la opción ‘Go to ABAP Workbench’


Se muestra la siguiente visualización

Necesitamos redefinir el método /IWBEP/IF_MGW_APPL_SRV_RUNTIME~GET_EXPANDED_ENTITYSET, para ello nos dirigimos a ‘Methods>Inherited Methods> /IWBEP/IF_MGW_APPL_SRV_RUNTIME/GET_EXPANDED_ENTITYSET ’ . Clic derecho y elegir la opción ‘Redefine’.


Agregamos el siguiente código para obtener las aerolíneas con sus respectivos vuelos TYPES: ty_flight TYPE STANDARD TABLE OF ZCL_ZSFLIGHT_PROYECT O_MPC=>TS_FLIGHT WITH DEFAULT KEY. TYPES: BEGIN OF ty_carrier. INCLUDE TYPE ZCL_ZSFLIGHT_PROYECTO_MPC=>TS_C ARRIER. types: vuelosdeaerolinea type ty_flight, END OF ty_carrier. DATA:

ls_key_tab lv_carrid

DATA: ltd_flight lwa_flight ltd_carrier lwa_carrier

TYPE /iwbep/s_mgw_name_value_pair, TYPE scarr-carrid. TYPE like TYPE TYPE

DATA: ltd_carrier2 lwa_carrier2 ltd_flight2 lwa_flight2

TYPE TYPE TYPE like

ZCL_ZSFLIGHT_PROYECTO_MPC=>TT_FLIGHT, LINE OF ltd_flight, STANDARD TABLE OF ty_carrier, ty_carrier. STANDARD TABLE OF scarr, scarr, STANDARD TABLE OF sflight, LINE OF ltd_flight2.

CONSTANTS: lc_expand_tech_clause EROLINEA'.

TYPE string VALUE 'VUELOSDEA

SELECT * from scarr into TABLE ltd_carrier2. IF ltd_carrier2 is NOT INITIAL. SELECT * from sflight into CORRESPONDING FIELDS OF TABLE ltd_flight2 FOR ALL ENTRIES IN ltd_carrier2 WHERE carrid EQ ltd_carrier2-carrid. delete ltd_carrier2 WHERE carrid eq space. delete ltd_flight2 WHERE carrid eq space. IF ltd_flight2[] is not INITIAL. LOOP AT LTD_CARRIER2 into lwa_carrier2. REFRESH: LTD_FLIGHT. MOVE-CORRESPONDING LWA_CARRIER2 to LWA_CARRIER. LOOP AT LTD_FLIGHT2 into lwa_flight2 WHERE carrid EQ lwa_carrier2-carrid. MOVE-CORRESPONDING lwa_flight2 to lwa_flight. append lwa_flight to LTD_FLIGHT. ENDLOOP.


lwa_carrier-VUELOSDEAEROLINEA[] = LTD_FLIGHT. ENDLOOP. MOVE-CORRESPONDING lwa_carrier2 to lwa_carrier. lwa_carrier-VUELOSDEAEROLINEA = ltd_flight[]. append lwa_carrier to LTD_CARRIER. ENDIF. ENDIF.

* Fill ER_ENTITY copy_data_to_ref( EXPORTING is_data = ltd_carrier CHANGING cr_data = ER_ENTITYSET ). * Insert Navigation property into ET_EXPANDED_TECH_CLAUSES INSERT lc_expand_tech_clause INTO TABLE et_expanded_tech_claus es.

Con este paso estaríamos finalizando la implementación del método /IWBEP/IF_MGW_APPL_SRV_RUNTIME~GET_EXPANDED_ENTITYSET.


Manual de ODATA

Recommend Documents