Actividad de consulta de OData

Introducción

Una actividad Consulta de OData, que utiliza su conexión OData, consulta datos de objetos desde un extremo de OData y está destinado a ser utilizado como una fuente para proporcionar datos en una operación.

Crear una actividad de consulta OData

Se crea una instancia de una actividad OData Query 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 tela de diseño de tela de diseño o cópielo y péguelo en él. Para obtener más información, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Se puede editar una actividad de Consulta de OData existente desde estas ubicaciones:

• El tela de diseño (vea menú de acciones del componente en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (vea menú de acciones de componentes en la pestaña Componentes del panel Proyecto).

Configurar una actividad de consulta OData

Siga estos pasos para configurar una actividad de Consulta de OData:

• Paso 1: Ingrese un nombre y especifique la configuración
  Proporcione un nombre para la actividad, especifique la clase de objeto a consultar y especifique los encabezados HTTP necesarios.

• Paso 2: Seleccionar objetos secundarios
  Seleccione las clases de objetos secundarios que desea consultar en función de la clase de objeto seleccionada en el paso anterior.

• Paso 3: Definir una cadena de filtro
  El Generador de consultas se utiliza para establecer condiciones en una consultar usando los campos de objeto y aplicar paginación a una consultar.

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

Paso 1: Ingrese un nombre y especifique la configuración

En este paso, asigne un nombre a la actividad y especifique la clase de objeto que consultar, así como los encabezados HTTP necesarios. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

Consejo

Campos con un icono de variable soporte utilizando variables globales, variables del proyecto y variables de Jitterbit. Comience escribiendo un corchete abierto [ en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes para elegir.

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

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

  • Objeto seleccionado: Después de seleccionar una clase de objeto, esta aparece aquí.

  • Buscar: Introduzca 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 se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el extremo durante la búsqueda, introduzca los criterios de búsqueda y actualice, como se describe a continuación.

  • Actualizar: Haga clic en el icono de actualización O la palabra Refresh para recargar las clases de objeto desde el extremo de OData. Esto puede ser útil si el esquema del punto de conexión de OData se ha actualizado para admitir nuevos tipos de objetos. Esta acción actualiza todos los metadatos utilizados para crear la tabla de objetos que se muestra 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 extremo de OData:

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

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

  Consejo

  Si la tabla no se completa con las clases de objetos disponibles, la conexión OData podría no funcionar correctamente. Asegúrese de estar conectado reabriendo la conexión y probando las credenciales.

• Propiedades HTTP avanzadas: Defina los encabezados HTTP para la consultar. El protocolo OData acepta los encabezados HTTP estándar definidos en Rfc 2616 (sección 14) así como cualquier encabezado personalizado específico del extremo. haga clic en el ícono agregar para agregar un encabezado a la tabla a continuación e ingresar 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 edición. o eliminar icono .

  Para eliminar todas las filas, haz clic en Borrar todo.

  Nota

  Se deben configurar encabezados personalizados en el extremo para que este los acepte como parte de esta solicitud. Si utiliza Microsoft Azure para administrar su extremo de OData, consulte la documentación de Microsoft sobre Encabezados personalizados en Acceso a Extremos que requieren autenticación.

  Importante

  Los campos de la tabla Propiedades HTTP avanzadas muestran el icono de variable Solo en modo de edición. Para que los valores de las variables de estos campos se rellenen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.

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

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

• Siguiente: Haga clic para guardar temporalmente la configuración de este paso y continuar con el siguiente. 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 los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá que confirme que desea descartar los cambios.

Paso 2: Seleccionar objetos secundarios

En este paso, seleccione las clases de objetos secundarios que se incluirán en la consultar según la clase de objeto seleccionada en el paso anterior. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

• Seleccionar objetos secundarios: Esta sección se utiliza para seleccionar las clases de objetos secundarios que se consultar. Esta sección es opcional y puede omitirse seleccionando Siguiente.

  • Objetos secundarios disponibles: Esta columna muestra las clases de objetos secundarios para seleccionar.

    • Buscar: Introduzca el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de clases de objetos secundarios. La búsqueda no distingue entre mayúsculas y minúsculas. Si las clases de objetos ya se muestran en la tabla, los resultados se filtran en tiempo real con cada pulsación de tecla. Para recargar las clases de objetos secundarios desde el extremo durante la búsqueda, introduzca los criterios de búsqueda y actualice, como se describe a continuación.

    • Actualizar: Haga clic en el ícono de actualización para recargar las clases de objetos secundarios desde el extremo de OData. Esto puede ser útil si ha añadido recientemente clases de objetos secundarios al extremo de OData.

    • Añadir un objeto secundario: Dentro de la columna, haga clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. A continuación, haga clic en el icono de añadir. Para agregar las clases seleccionadas a la columna Objetos secundarios seleccionados.

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

    • Eliminar un objeto secundario: Dentro de la columna, haga clic en cualquier parte de una fila para seleccionar una o más clases de objetos secundarios. Luego, haga clic en el icono de eliminar. Para devolver las clases seleccionadas a la columna Objetos secundarios disponibles.

• Atrás: Haga clic para guardar temporalmente la configuración de este paso y volver al paso anterior.

• Siguiente: Haga clic para guardar temporalmente la configuración de este paso y continuar con el siguiente. 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 los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá que confirme que desea descartar los cambios.

Paso 3: Definir una cadena de filtro

En este paso, se define la Cadena de Filtro de una consultar mediante los campos de objeto disponibles y la configuración de la consultar. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

Consejo

Campos con un icono de variable soporte utilizando variables globales, variables del proyecto y variables de Jitterbit. Comience escribiendo un corchete abierto [ En el campo o haciendo clic en el icono de la variable para ver una lista de las variables existentes.

La Cadena de filtro se puede configurar en las pestañas Básico o Avanzado.

Nota

Los cambios realizados en una pestaña no se reflejarán en la otra. La consultar de cadena de filtro para el modo seleccionado al cerrar el conector será la consultar que se utilice para el conector.

• Básico: Le permite construir la Cadena de filtro con campos guiados:

  

  • Campos de objeto: Seleccione los campos que se utilizarán en la consultar en función de la clase de objeto seleccionada.

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

    • Actualizar: Haga clic en el icono de actualización o la palabra Actualizar para recargar los campos del objeto desde el extremo de OData.

    • Seleccionar todo en la clase de objeto: Al usar el cuadro de búsqueda para filtrar, puede usar esta casilla de verificación para seleccionar todos los campos visibles a la vez.

    • Seleccionar campos: Marque las casillas de los campos que desea incluir en la consultar para que se agreguen automáticamente a la cadena de filtro. También puede seleccionar todos los campos a la vez usando la casilla principal.

  • Tamaño de página: Introduzca el número máximo de resultados que se obtendrán para cada página en la respuesta de la consultar. Si se deja en blanco, cada página contendrá 100 resultados.

    Nota

    Si se requiere paginación del lado del cliente, utilice los campos Omitir y Arriba.

  • Incluir recuento: Seleccione esta opción para incluir el número de resultados de una consultar como parte de la respuesta. Por ejemplo, si una consultar devuelve 5 resultados en total, la respuesta también incluirá "_odata.count": 5.

  • Búsqueda de texto completo: Introduzca términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El extremo OData gestiona cómo se interpreta la búsqueda para una clase de objeto.

  • Omitir: Ingrese el número de resultados que se omitirán en la respuesta de la consultar. Se utiliza para la paginación del lado del cliente.

  • Principal: Introduzca el número máximo de resultados que se recibirán en la respuesta de la consultar. Se utiliza para la paginación del lado del cliente.

  • Cláusulas condicionales: Para agregar condicionales, utilice estos campos como entrada para ayudar a construir las cláusulas, que luego aparecen en la Cadena de filtro.

    • Objeto: Utilice el menú desplegable para seleccionar la clase de objeto que se utilizará para el condicional.

    • Campo: Utilice el menú desplegable para seleccionar el campo de la clase de objeto que se utilizará para el condicional.

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

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

    • Valor: Ingrese el valor deseado para comparar con las selecciones desplegables anteriores.

    • Eliminar: Haga clic para eliminar el condicional.

    • Agregar: Haga clic para agregar una nueva condicional a la tabla Cláusulas condicionales y a la Cadena de filtro.

    • Eliminar todo: Haga clic para eliminar todos los condicionales de la tabla Cláusulas condicionales y la Cadena de filtro.

  • Cadena de filtro: A medida que completa los demás campos en la pestaña Básico, la declaración de cadena de filtro en este cuadro de texto se completa automáticamente con los campos, las condiciones y las opciones de consultar seleccionados.

• Avanzado: Oculta los campos guiados y le permite modificar la Cadena de filtro directamente:

  

  • Tamaño de página: Introduzca el número máximo de resultados que se obtendrán para cada página en la respuesta de la consultar. Si se deja en blanco, cada página contendrá 100 resultados.

    Nota

    Si se requiere paginación del lado del cliente, utilice el $skip y $top opciones de consultar en el campo Cadena de filtro.

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

• Consulta de prueba: Haga clic para validar la consultar. Si la consultar es válida, se muestra en una tabla una muestra de hasta 10 consultar recuperados. Si la consultar no es válida, se muestran los mensajes de error pertinentes. Si edita la cadena de filtro en el modo Avanzado, la consultar debe ser válida y validarse mediante este botón para habilitar el botón Siguiente.

  

• Atrás: Haga clic para guardar temporalmente la configuración de este paso y volver al paso anterior.

• Siguiente: Haga clic para guardar temporalmente la configuración de este paso y continuar con el siguiente. 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 los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá que confirme que desea descartar los cambios.

Paso 4: Revisar el esquema de datos

Se muestra el esquema de respuesta generado desde el extremo. A continuación, se describe cada elemento de la interfaz de usuario de este paso.

• Esquema de datos: Este esquema de datos es heredado por las transformaciones adyacentes y se muestra nuevamente durante el mapeo de transformación.

  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 consultar
    item	Nodo que representa los elementos de respuesta
    Lista de objetos	Nodo que representa la lista de objetos (conjunto de entidades) consultada; por ejemplo, Person nodo
    _odata.nextLink	Cadena del campo de anotación OData con una URL utilizada para recuperar el siguiente subconjunto de resultados de la respuesta de la consultar solicitada
    _odata.count	Cadena del campo de anotación OData con un recuento total de objetos devueltos de la consultar
    _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 consultar
    item	Nodo que representa un objeto coincidente de la consultar
    Campos de objeto ...	Campos específicos de la clase de objeto (tipo de entidad) de los objetos en la lista de objetos; por ejemplo, campos en item nodo, como por ejemplo 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 consultar
    code	Cadena del código asociado al error
    message	Cadena del mensaje asociado al error

  El conector OData utiliza la [biblioteca Java Apache Olingo OData 4.0](http://olingo.incubator.apache.org/`Consulte la documentación de la biblioteca para obtener más información sobre la compatibilidad con el protocolo OData. También encontrará información general sobre el protocolo OData en el sitio de documentación de OData.

• Actualizar: Haz clic en el icono de actualización. o la palabra Refresh para regenerar esquemas desde el extremo de OData. Esta acción también regenera un esquema en otras ubicaciones del proyecto donde se hace referencia al esquema, como en una transformación adyacente.

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

• Terminado: Haga 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, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pedirá que confirme que desea descartar los cambios.

Próximos pasos

Después de configurar una actividad OData Query, complete la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de la operación. También puede configurar los ajustes de la operación, lo que incluye la posibilidad de encadenar operaciones que se encuentren en el mismo flujo de trabajo o en flujos de trabajo diferentes.

Se puede acceder a las acciones del menú de una actividad desde el panel del proyecto y el tela de diseño. Para más detalles, consulte menú de acciones de la actividad en Conceptos básicos del conector.

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

• Patrón de Transformación
• Patrón de archivo de dos objetivos (solo como primera fuente) - Patrón de archivo HTTP de dos destinos (solo como primera fuente)
• Patrón de dos transformaciones (solo como primera fuente)

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

Cuando esté listo, desplegar y ejecutar la operación y validar el comportamiento comprobando los registros de operación.

Nota

La actividad Consulta de OData puede devolver una advertencia de subelemento adicional según la configuración del esquema del endpoint. Esto se debe a que algunos campos de OData no están incluidos en los metadatos del endpoint, pero no afecta la ejecución de la actividad.