✒️SAP BTPFIORI / La validación de los servicios OData desde el backend Por Jose Baz Suarez

La validación de los servicios OData desde el backend

---

1. Introducción

Después de implementar un servicio OData en SAP Gateway, es fundamental validar su funcionamiento desde el backend antes de consumirlo en aplicaciones SAPUI5 o Fiori.
La validación permite asegurarse de que el servicio:

• Está correctamente registrado y activo,

• Devuelve los datos esperados,

• Y cumple con las operaciones CRUD-Q definidas.

SAP proporciona varias herramientas para realizar esta verificación, siendo las principales /IWFND/GW_CLIENT, /IWFND/ERROR_LOG y /IWFND/TRACES.

---

2. Objetivo de la validación

El propósito de la validación es comprobar la comunicación entre el Gateway y el servicio OData dentro del sistema SAP.
Esto incluye verificar que:

• El modelo esté correctamente expuesto.

• Los métodos implementados (GET, POST, PUT, DELETE) respondan como se espera.

• No existan errores de autorización, mapeo o metadatos.

• La respuesta del servicio esté en formato correcto (XML o JSON).

La validación en backend garantiza que, cuando el servicio sea consumido por SAPUI5, funcione sin errores.

---

3. Herramientas para validar un servicio OData 🔹 a) /IWFND/GW_CLIENT (Gateway Client)

Es la herramienta principal para probar servicios OData directamente desde SAP.

Pasos:

1. Ejecutar la transacción /IWFND/GW_CLIENT.

2. Ingresar la URL del servicio, por ejemplo:

   /sap/opu/odata/sap/Z_ODATA_CLIENTES_SRV/CustomerSet

3. Elegir el método HTTP (GET, POST, PUT o DELETE).

4. Presionar Execute.

5. Revisar el Response Body (respuesta) y el Response Header.

Ventajas:

• Permite probar las operaciones CRUD individualmente.

• Muestra errores detallados con el código HTTP correspondiente (200, 400, 404, etc.).

• Muestra el tiempo de ejecución y los encabezados del mensaje.

---

🔹 b) /IWFND/TRACES (SAP Gateway Traces)

Permite rastrear la ejecución de las llamadas OData realizadas al servicio, mostrando qué clases y métodos fueron invocados.

Pasos:

1. Ingresar a la transacción /IWFND/TRACES.

2. Activar el trace para el usuario actual (clic en Activate Trace for User).

3. Ejecutar el servicio desde /IWFND/GW_CLIENT.

4. Volver a /IWFND/TRACES y visualizar los resultados.

Información útil:

• Métodos ejecutados (GET_ENTITYSET, CREATE_ENTITY, etc.).

• Tiempo de ejecución (performance).

• Excepciones lanzadas.

• Mensajes del framework OData.

💡 Recomendación: mantener el trace activo solo durante pruebas, ya que impacta en el rendimiento.

---

🔹 c) /IWFND/ERROR_LOG

Registra los errores producidos durante la ejecución de servicios OData.

Uso típico:

• Detectar errores de autorización.

• Errores de implementación en DPC_EXT.

• Problemas con la conversión de tipos de datos o acceso a tablas.

Permite ver el detalle del error, el usuario que lo provocó y la fecha/hora.

---

🔹 d) /IWFND/MAINT_SERVICE

Permite registrar, activar y verificar el estado de los servicios.
Aquí se puede comprobar:

• Si el servicio está registrado correctamente.

• En qué sistema backend se ejecuta.

• La versión y fecha de creación.

También ofrece la opción de probar el servicio directamente (botón SAP Gateway Client).

---

4. Validaciones técnicas comunes

Durante la verificación del servicio, se deben controlar los siguientes puntos:

---

5. Errores frecuentes en la validación

---

6. Validación del documento de metadatos

El documento de metadatos se obtiene agregando ?$metadata a la URL del servicio:

Debe devolver un XML con la definición completa del modelo (entidades, propiedades, asociaciones, etc.).
Si este documento se carga sin errores, significa que la parte del modelo está configurada correctamente.

---

7. Buenas prácticas

• Validar primero el $metadata, luego los EntitySets.

• Utilizar /IWFND/GW_CLIENT para probar cada operación CRUD por separado.

• Analizar el log de errores después de cada prueba.

• Mantener las trazas activas solo durante las validaciones.

• Documentar los resultados (endpoint, usuario, tiempos, respuesta).

• Revisar los códigos HTTP devueltos (200 = OK, 400 = Bad Request, 500 = Error interno).

---

8. Conclusión

La validación de los servicios OData desde el backend garantiza que la aplicación SAPUI5 o Fiori pueda consumir datos confiables y estables.
Verificar correctamente la configuración, el registro y las respuestas de los servicios evita errores en producción y asegura la integridad de la comunicación entre el backend SAP y la capa de presentación.

---

Preguntas de repaso

1. ¿Qué transacción se utiliza para probar directamente un servicio OData?
   → /IWFND/GW_CLIENT

2. ¿Qué transacción muestra las trazas de ejecución del servicio?
   → /IWFND/TRACES

3. ¿Qué indica el error HTTP 404 al probar un servicio?
   → Que la URL es incorrecta o el método no fue implementado.

4. ¿Qué devuelve el parámetro $metadata en la URL de un servicio?
   → El documento XML con la estructura y definición del modelo OData.

5. ¿Qué se debe revisar en /IWFND/ERROR_LOG?
   → Los errores de ejecución o autorización del servicio.