Actividad de consulta OData en Jitterbit Studio

Introducción

Una actividad de Consulta OData, utilizando su conexión OData, consulta datos de objetos desde un punto final OData y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.

Crear una actividad de consulta OData

Una instancia de una actividad de Consulta OData se crea a partir de una conexión OData utilizando su tipo de actividad Consulta.

Para crear una instancia de una actividad, arrastre el tipo de actividad al lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad de Consulta OData existente se puede editar desde estas ubicaciones:

• El lienzo de diseño (consulte Menú de acciones del componente en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (consulte Menú de acciones del componente en Pestaña de componentes del panel del proyecto).

Configurar una actividad de consulta OData

Siga estos pasos para configurar una actividad de Consulta OData:

• Paso 1: Ingrese un nombre y especifique configuraciones
  Proporcione un nombre para la actividad, especifique la clase de objeto a consultar y especifique cualquier encabezado HTTP necesario.

• Paso 2: Seleccione objetos secundarios
  Seleccione clases de objetos secundarios para consultar según la clase de objeto seleccionada en el paso anterior.

• Paso 3: Defina una cadena de filtro
  Se utiliza el Constructor de consultas para establecer condiciones en una consulta utilizando los campos del objeto y aplicar paginación a una consulta.

• Paso 4: Revisar el esquema de datos
  Se muestran los esquemas de respuesta generados desde el endpoint.

Paso 1: Ingresar un nombre y especificar configuraciones

En este paso, proporciona un nombre para la actividad y especifica la clase de objeto a consultar y cualquier encabezado HTTP necesario. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Menú de endpoint: Si tienes múltiples endpoints del mismo tipo de conector configurados, un menú en la parte superior de la pantalla muestra el nombre del endpoint actual. Haz clic en el menú para cambiar a un endpoint diferente. Para más información, consulta Cambiar el endpoint asignado en Pantallas de configuración.

  • Editar endpoint: Aparece cuando pasas el cursor sobre el nombre del endpoint actual. Haz clic para editar la configuración de conexión del endpoint seleccionado actualmente.

• Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Consulta OData y no debe contener barras inclinadas (/) o dos puntos (:).

• Seleccionar Objeto: Esta sección muestra las clases de objeto disponibles en el endpoint OData.

  • Objeto Seleccionado: Después de seleccionar una clase de objeto, se lista aquí.

  • Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de objetos. La búsqueda no distingue entre mayúsculas y minúsculas. Si los objetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el endpoint al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

  • Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para recargar las clases de objeto desde el endpoint OData. Esto puede ser útil si el esquema del endpoint OData se ha actualizado para soportar nuevos tipos de objetos. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrada en la configuración.

  • Seleccionar un Objeto: Dentro de la tabla, haga clic en cualquier parte de una fila para seleccionar una clase de objeto. Solo se puede seleccionar una clase de objeto. La información disponible para cada objeto se obtiene del endpoint OData:

    • Nombre: El nombre de la clase de objeto del endpoint OData.

    • Descripción: La descripción de la clase de objeto del endpoint OData.

  Consejo

  Si la tabla no se llena con las clases de objeto disponibles, la conexión OData puede no haber sido exitosa. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

• Propiedades HTTP Avanzadas: Defina los encabezados HTTP para la consulta. El protocolo OData acepta encabezados HTTP estándar definidos en Rfc 2616 (sección 14) así como cualquier encabezado personalizado específico del endpoint. Haga clic en el ícono de agregar para añadir un encabezado a la tabla de abajo e ingrese un par clave-valor para cada parámetro de solicitud.

  Para guardar la fila, haga clic en el ícono de enviar en la columna más a la derecha.

  Para editar o eliminar una sola fila, pase el cursor sobre la columna más a la derecha y use el ícono de editar o el ícono de eliminar .

  Para eliminar todas las filas, haga clic en Limpiar Todo.

  Nota

  Los encabezados personalizados deben configurarse en el endpoint para que los acepte como parte de esta solicitud. Si está utilizando Microsoft Azure para gestionar su endpoint OData, consulte la documentación de Microsoft sobre Encabezados Personalizados en Accediendo a Endpoints que Requieren Autenticación.

  Importante

  Los campos en la tabla de Propiedades HTTP Avanzadas muestran el ícono de variable solo en modo de edición. Para que los valores de variable de estos campos se llenen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

  Los campos en la tabla de Propiedades HTTP Avanzadas no admiten el uso de variables para pasar JSON en bruto. Si tu caso de uso no admite definir JSON en bruto en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar {"success": "true"}; se convierte en {\"success\": \"true\"};.

• Guardar y Salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 2: Seleccionar objetos hijos

En este paso, selecciona las clases de objetos hijos para incluir en la consulta según la clase de objeto seleccionada en el paso anterior. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Seleccionar Objetos Hijos: Esta sección se utiliza para seleccionar clases de objetos hijos para consultar. Esta sección es opcional y se puede omitir seleccionando Siguiente.

  • Objetos Hijos Disponibles: Esta columna muestra las clases de objetos hijos de las que se puede seleccionar.

    • Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de clases de objetos hijos. La búsqueda no distingue entre mayúsculas y minúsculas. Si las clases de objetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar las clases de objetos hijos desde el punto final al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

• Actualizar: Haz clic en el ícono de actualizar para recargar las clases de objetos secundarios desde el punto final de OData. Esto puede ser útil si has agregado recientemente clases de objetos secundarios al punto final de OData.

• Agregar un Objeto Secundario: Dentro de la columna, haz clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego haz clic en el ícono de agregar para añadir las clases seleccionadas a la columna de Objetos Secundarios Seleccionados.

• Objetos Secundarios Seleccionados: Esta columna muestra las clases de objetos secundarios seleccionados.

• Eliminar un Objeto Secundario: Dentro de la columna, haz clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego haz clic en el ícono de eliminar para devolver las clases seleccionadas a la columna de Objetos Secundarios Disponibles.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 3: Definir una cadena de filtro

En este paso, se define la Cadena de Filtro de una consulta utilizando los campos de objeto disponibles y la configuración de la consulta. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

La Cadena de Filtro se puede configurar en las pestañas Básica o Avanzada.

• Básico: Permite construir la Cadena de Filtro con campos guiados.

  • Campos de Objeto: Selecciona los campos que se utilizarán en la consulta según la clase de objeto seleccionada.

    • Buscar: Ingresa cualquier parte del nombre de un campo en el cuadro de búsqueda para filtrar la lista de campos para el objeto seleccionado. La búsqueda no distingue entre mayúsculas y minúsculas. Los resultados listados se filtran en tiempo real con cada pulsación de tecla.

    • Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para recargar los campos del objeto desde el punto final de OData.

    • Seleccionar Todo en Clase de Objeto: Al usar el cuadro de búsqueda para filtrar, puedes utilizar esta casilla de verificación para seleccionar todos los campos visibles a la vez.

    • Seleccionar Campos: Selecciona las casillas de verificación de los campos que deseas incluir en la consulta para que se agreguen automáticamente a la Cadena de Filtro. También puedes seleccionar todos los campos a la vez usando la casilla de verificación principal.

  • Tamaño de Página: Ingresa el número máximo de resultados a recuperar para cada página en la respuesta de la consulta. Si se deja vacío, cada página contendrá 100 resultados.

    Nota

    Si se requiere paginación del lado del cliente, utiliza los campos Saltar y Máximo.

  • Incluir Conteo: Selecciona incluir el número de resultados de una consulta como parte de la respuesta. Por ejemplo, si una consulta devuelve un total de 5 resultados, la respuesta también incluirá "_odata.count": 5.

  • Búsqueda de Texto Completo: Ingresa términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El punto final de OData maneja cómo se interpreta la búsqueda para una clase de objeto.

  • Saltar: Ingresa el número de resultados a omitir en la respuesta de la consulta. Se utiliza para la paginación del lado del cliente.

  • Máximo: Ingresa el número máximo de resultados a recibir en la respuesta de la consulta. Se utiliza para la paginación del lado del cliente.

  • Cláusulas Condicionales: Para agregar condicionales, utiliza estos campos como entrada para ayudar a construir las cláusulas, que luego aparecerán en la Cadena de Filtro.

    • Objeto: Utiliza el menú desplegable para seleccionar la clase de objeto que se usará para la condición.

    • Campo: Utiliza el menú desplegable para seleccionar el campo de la clase de objeto que se usará para la condición.

    • Operador: Utiliza el menú desplegable para seleccionar un operador apropiado:

      Comparación
      Igual
      Mayor que
      Mayor o igual que
      Menor que
      Menor o igual que

    • Valor: Ingresa el valor deseado para comparar con las selecciones anteriores del menú desplegable.

    • Eliminar: Haz clic para eliminar la condición.

    • Agregar: Haz clic para agregar una nueva condición a la tabla de Cláusulas Condicionales y Cadena de Filtro.

    • Eliminar Todo: Haz clic para eliminar todas las condiciones de la tabla de Cláusulas Condicionales y Cadena de Filtro.

  • Cadena de Filtro: A medida que completes los otros campos en la pestaña Básica, la declaración de la cadena de filtro en este cuadro de texto se completa automáticamente con los campos seleccionados, condiciones y opciones de consulta.

• Avanzado: Oculta los campos guiados y te permite modificar la Cadena de Filtro directamente.

  • Tamaño de Página: Ingresa el número máximo de resultados a recuperar para cada página en la respuesta de la consulta. Si se deja vacío, cada página contendrá 100 resultados.

    Nota

    Si se requiere paginación del lado del cliente, utiliza las opciones de consulta $skip y $top en el campo de Cadena de Filtro.

  • Cadena de Filtro: Edita la declaración de la cadena de filtro directamente.

• Probar Consulta: Haz clic para validar la consulta. Si la consulta es válida, se muestra una muestra de hasta 10 registros recuperados de la consulta en una tabla. Si la consulta no es válida, se muestran mensajes de error relevantes. Si editas la cadena de filtro mientras estás en modo Avanzado, la consulta debe ser válida y validada a través de este botón para habilitar el botón Siguiente.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.

• Descartar Cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pide que confirme que desea descartar los cambios.

Paso 4: Revisar el esquema de datos

Se muestra el esquema de respuesta generado desde el endpoint. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Esquema de Datos: Este esquema de datos es heredado por transformaciones adyacentes y se muestra nuevamente durante mapeo de transformaciones.

  Nota

  Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

  • Respuesta:

    Campo/Nodo del Esquema de Respuesta	Descripción
    queryresponse	Respuesta de la consulta de objetos (entidades)
    response	Nodo que representa la respuesta de la consulta
    item	Nodo que representa los elementos de la respuesta
    Lista de Objetos	Nodo que representa la lista de objetos (conjunto de entidades) consultados; por ejemplo, el nodo Person
    _odata.nextLink	Cadena del campo de anotación OData con una URL utilizada para recuperar el siguiente subconjunto de resultados de la respuesta de consulta solicitada
    _odata.count	Cadena del campo de anotación OData con el conteo total de objetos devueltos de la consulta
    _odata.context	Cadena del campo de anotación OData con una URL que contiene la ubicación de la lista de objetos consultados
    value	Nodo que representa la lista de objetos coincidentes de la consulta
    item	Nodo que representa un objeto coincidente de la consulta
    Campos del Objeto ...	Campos específicos de la clase de objeto (tipo de entidad) de los objetos en la lista de objetos; por ejemplo, campos en el nodo item, como UserName y Concurrency
    _odata.etag	Cadena del campo de anotación OData con un valor que se puede utilizar en una solicitud posterior para determinar si el valor del objeto ha cambiado
    error	Nodo que representa los detalles del error de la consulta
    code	Cadena del código asociado con el error
    message	Cadena del mensaje asociado con el error

  El conector OData utiliza la biblioteca Java OData de Apache Olingo. Consulta la documentación de la biblioteca para obtener información adicional sobre cómo se admite el protocolo OData. También hay información general sobre el protocolo OData disponible en el sitio de documentación de OData.

• Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el punto final de OData. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.

• Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

• Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

• Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Próximos pasos

Después de configurar una actividad de Consulta OData, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puedes configurar la configuración de la operación, que incluye la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulta el menú de acciones de actividad en Conceptos básicos del conector.

Las actividades de Consulta OData se pueden utilizar como fuente con estos patrones de operación:

• Patrón de transformación
• Patrón de archivo de dos destinos (solo como la primera fuente)
• Patrón de archivo HTTP de dos destinos (solo como la primera fuente)
• Patrón de dos transformaciones (solo como la primera fuente)

Para utilizar la actividad con funciones de scripting, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de scripting.

Cuando esté listo, despliegue y ejecute la operación y valide el comportamiento revisando los registros de operación.