Análisis del rendimiento de la API de EC OData

La API de OData admite algunas operaciones http, como GET, POST, PUT, PATCH y DELETE, utilizamos las operaciones básicas para obtener o editar entidades como Usuario, PerPerson, lista desplegable, etc. en EC

Operaciones HTTP

• GET: Consulta
• POST: Crear
• PUT: Actualizar
• PATCH: Actualización parcial
• DELETE: Borrar

Recursos o servicios HTTP

• Usuario, PerPerson, lista desplegable, posición

Parámetro HTTP

• Separado por "?" (primero después de Recurso) y "&" caracteres
• Los parámetros estándar de OData empiezan con un carácter "$", como $filter o $select

Definición XML de metadatos API

• Se puede recuperar mediante la API de OData $metadata y se puede importar un resultado después de descargarlo en Excel:

Para obtener información adicional, como etiquetas de idioma, listas desplegables, más allá de lo que proporcionan los metadatos OData estándar, OData de SAP SuccessFactors expone metadatos como una entidad. La API de OData de SAP SuccessFactors expone una entidad llamada "Entidad". Sus propiedades se exponen como valor de tipo complejo incrustado en el cuerpo de respuesta de "Entidad". Por lo tanto, se pueden exponer diferentes formas de metadatos sin modificar el formato de metadatos OData estándar. Puede acceder a los nuevos metadatos del mismo modo que accedería a una entidad normal. Además, admite un filtro simple para emitir metadatos de una entidad específica.

Los metadatos se pueden obtener mediante la API de OData mediante $metadata en la llamada https. Puede solicitar los metadatos a través de Firefox Rest Client. Dado que los datos son un poco grandes para los metadatos, la solicitud puede tardar más tiempo.

Seleccione el botón de reproducción para obtener información sobre el parámetro $format.

Opciones y parámetros de filtro

El siguiente ejemplo muestra un ejemplo de consulta de la API de OData mediante filtro y seleccione. Para el filtro podemos dar un valor especificado a un campo para consultar en la entidad correspondiente. Para la selección también podemos definir los campos para devolver la respuesta.

• $filter=personIdExternal%20eq%20’greinhard’

  • %20 es un carácter de escape especial para espacio; como %28 y %29 para paréntesis como "(" y ")"

  • Los operadores disponibles son EQ,NE,GT,GE,LT,GT y se pueden combinar con NOT, AND y OR

• $select=firstName define los campos que se devolverán separados por espacios

En el siguiente ejemplo se muestra cómo utilizar el parámetro de expandir. Despliegue siempre utilizado para navegar a otra entidad.

Expandir los datos: navegar por el modelo de datos

• $expand=personNav
• $select=firstName,personNav

  • despliega firstName en el recurso raíz y todos los campos en la persona del recurso navegada

• $select=firstName,personNav/dateOfBirth

  • despliega firstName en el recurso raíz y todos los campos en la persona del recurso navegada

El ejemplo anterior nos muestra cómo utilizar el parámetro de $expand y $filter

La respuesta identifica un conjunto de entidades de usuario cuya propiedad personNav/emailNav es emailAddress que es igual a gerald.reinhard@sap.com. Después de recuperar las entidades, la respuesta elimina las columnas no seleccionadas. A continuación, la opción $deploy despliega las columnas seleccionadas que es una propiedad de navegación

Filtrado profundo mediante $filter y $expand

• $expand realizado después del filtro independientemente el uno del otro (ver el resultado de la siguiente diapositiva)
• $select no es necesario para los atributos filtrados

Filtrar+Desplegar

• Filtro aplicado al recurso raíz
• Desplegar aplicado a recurso raíz filtrado
• Resultado: el correo electrónico expandido no coincide con el filtro

El siguiente contenido describe cómo consultar entidades con fecha efectiva, para utilizar fromDate y toDate devolverá todos los datos históricos de la entidad raíz en la respuesta. Pero si la entidad raíz no es una fecha efectiva, fromDate y toDate se aplicarán a la siguiente entidad con fecha efectiva en la jerarquía de navegación, y se devolverán todos los registros con fecha efectiva que caigan en el intervalo de tiempo entre fromDate y toDate.

Además, si se devuelven datos históricos de un registro con fecha efectiva y se realiza una navegación/expansión de esos registros a otro registro con fecha efectiva, se utilizará la fecha de inicio de la primera entidad con fecha efectiva para filtrar el segundo.

• Para que las entidades con fecha efectiva le indiquen a la API que devuelva todos los datos históricos de la entidad raíz en la respuesta.
• Si la entidad raíz no tiene fecha de entrada en vigor toDate y fromDate se aplicará a la siguiente entidad con fecha de entrada en vigor en la jerarquía de navegación:
  • https://salesdemo4.successfactors.com:443/odata/v2/PerPerson? $filter=employmentNav/jobInfoNav/userId%20eq%20'greinhard‘ &fromDate=1900-01-01 &$select=employmentNav/jobInfoNav/startDate,employmentNav/jobInfoNav/departmentNav/externalCode &$expand=employmentNav/jobInfoNav/departmentNav/departmentNav
• Se devolverán todos los registros con fecha efectiva comprendidos en el intervalo de tiempo entre fromDate y toDate.

• Si se devuelven datos históricos de un registro con fecha efectiva y se realiza una navegación/expansión de esos registros a otro registro con fecha efectiva, se utilizará la fecha de inicio de la primera entidad con fecha efectiva para filtrar el segundo.
  • https://salesdemo4.successfactors.com:443/odata/v2/EmpJob? $filter=userId%20eq%20'greinhard'&fromDate=1900-01-01 &$select=startDate,departmentNav/externalCode &$expand=departmentNav

Describe cómo consultar entidades con fecha efectiva para utilizar fromDate y toDate devolverá todos los datos históricos de la entidad raíz en la respuesta. Pero si la entidad raíz no es una fecha efectiva, fromDate y toDate se aplicarán a la siguiente entidad con fecha efectiva en la jerarquía de navegación, y se devolverán todos los registros con fecha efectiva que caigan en el intervalo de tiempo entre fromDate y toDate.

Además, si se devuelven datos históricos de un registro con fecha efectiva y se realiza una navegación/expansión de esos registros a otro registro con fecha efectiva, se utilizará la fecha de inicio de la primera entidad con fecha efectiva para filtrar el segundo

• Eliminaciones parciales no admitidas para entidades sin fecha efectiva como PerEmail, PerPhone
• La eliminación completa aún no es compatible con ninguna API
• lastModifiedOn (huso horario del servidor) lastModifiedDateTime (UTC)

• La API de OData proporciona varias opciones de paginación para los resultados de la consulta.
• Una única solicitud HTTP GET de OData puede devolver como máximo 1.000 registros. Esto es razonable porque la mayoría de los clientes HTTP tienen un límite de tiempo de espera de 2 a 5 minutos.
• Una solicitud que se ejecuta durante más tiempo del límite obtiene un error de tiempo de espera HTTP. Por lo tanto, a menudo es necesario ajustar consultas complejas y reducir el tamaño de los datos para que se completen dentro de la restricción de tiempo de espera.

El cliente puede elegir entre dos tipos de paginación:

• Paginación de cliente
• Paginación del servidor

• La paginación de cliente es el mecanismo de paginación más fundamental. Utiliza opciones de consulta en el lado del cliente para crear un "offset" que restringe la cantidad de datos devueltos por el servidor. Un cliente utiliza el siguiente parámetro URI.
• Un cliente utiliza el siguiente parámetro URI:
  • El parámetro $top indica el número de registros que se devolverán en el lote. El número predeterminado y máximo es de 1.000 registros.
  • El parámetro $skip indica el número de registros en el conjunto de datos completo que se omitirá antes de obtener los datos.
• Por ejemplo, una consulta con $skip=2000&$top=500 devuelve la quinta página de datos donde el tamaño de página es 500.

• A diferencia de la paginación de cliente, donde la paginación se controla mediante parámetros especificados por el cliente, la paginación del servidor se controla en el lado del servidor.
• Existen dos tipos de paginación de servidor: paginación basada en cursor y paginación basada en instantánea. Ambos tipos de paginación devuelven un parámetro "__next" al final de cada respuesta de consulta que contiene un valor $skiptoken que indica la siguiente página de datos.
• La paginación basada en cursores mantiene un "cursor" de base de datos en el servidor a lo largo de las solicitudes HTTP de paginación. El cursor representa un puntero al inicio de la página siguiente en el conjunto de datos completo. Esto se activa mediante el parámetro &paging=cursor URI.
• La paginación de instantáneas funciona guardando de forma persistente una lista de todas las claves empresariales del conjunto de datos en el servidor. Esto se activa mediante el parámetro URI &paging=snapshot.

Cuándo utilizar los diferentes tipos de paginación:

• Para el consumo de IU, utilice la paginación de offset de cliente. Este es el único método admitido en la IU.
• La paginación basada en cursores y la paginación basada en instantáneas se recomiendan para los casos de uso de integración.
• Le recomendamos que ajuste sus consultas cuando utilice la paginación basada en instantáneas. Si tiene problemas con el rendimiento de la primera página para conjuntos de datos extremadamente grandes, cambie a la paginación basada en cursores, si procede.

Por último, hemos optimizado las entidades OData FOLocation y FOPayGrade para la paginación basada en instantáneas para mejorar el rendimiento.