Actividad de Consulta de OData¶

Introducción¶

Una actividad OData Query, usando su conexión OData, consulta datos de objetos desde un extremo de OData y está diseñado para usarse como 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 o cópielo y péguelo en el tela de diseño. Para obtener más información, consulte Creación de una instancia de actividad en Reutilización de componentes.

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

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

Configurar una Actividad de Consulta OData¶

Siga estos pasos para configurar una actividad 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 clases de objetos secundarios para consultar según la clase de objeto seleccionada en el paso anterior.

• Paso 3: Definir una cadena de filtro
  El Creador de consultas se utiliza para establecer condiciones en una consultar utilizando 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, proporcione un nombre para la actividad y especifique la clase de objeto a consultar y los encabezados HTTP necesarios. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Nombre: Introduzca un nombre para identificar la actividad. El nombre debe ser único para cada actividad Query de OData 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, se enumera aquí.

  • Buscar: Ingrese cualquier parte del nombre del objeto 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 dentro de la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el extremo durante la búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.

  • Actualizar: Haga clic en el icono de actualización o la palabra Actualizar para recargar clases de objetos desde el extremo de OData. Esto puede resultar útil si el esquema del punto final 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 muestran en la configuración.

  • Seleccionar un objeto: Dentro de la tabla, haga clic en cualquier lugar de una fila para seleccionar una clase de objeto. Sólo 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 OData.

  Consejo

  Si la tabla no se completa con las clases de objetos disponibles, la conexión OData puede no tener éxito. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

• Propiedades HTTP avanzadas: Defina encabezados HTTP para la consultar. El protocolo OData acepta 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 siguiente tabla e ingresar un par clave-valor para cada parámetro de solicitud.

  Para guardar la fila, haga clic en el icono de enviar en la columna de la derecha.

  Para editar o eliminar una sola fila, coloque el cursor sobre la columna de la derecha y use el ícono de edición o eliminar icono .

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

  Nota

  Los encabezados personalizados deben configurarse en el extremo para que los acepte como parte de esta solicitud. Si está utilizando Microsoft Azure para administrar su extremo OData, consulte la documentación de Microsoft en Encabezados personalizados en Acceso a Extremos que requieren autenticación.

  Importante

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

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

• Siguiente: Haga clic para almacenar temporalmente la configuración para 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 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 2: Seleccionar Objetos Secundarios¶

En este paso, seleccione las clases de objetos secundarios para incluir en la consultar 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 secundarios: Esta sección se utiliza para seleccionar clases de objetos secundarios para consultar. Esta sección es opcional y se puede omitir seleccionando Siguiente.

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

    • Buscar: Ingrese cualquier parte del nombre de la clase de objeto secundario 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 dentro de la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar clases de objetos secundarios desde el extremo durante la búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.

    • Actualizar: Haga clic en el icono de actualización para recargar clases de objetos secundarios desde el extremo de OData. Esto puede resultar útil si recientemente agregó clases de objetos secundarios al extremo de OData.

    • Agregar un objeto secundario: Dentro de la columna, haga clic en cualquier lugar de una fila para seleccionar una o más clases de objetos secundarios. Luego haga clic en el ícono Agregar para agregar clases seleccionadas a la columna Objetos secundarios seleccionados:

      

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

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

      

• Volver: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

• Siguiente: Haga clic para almacenar temporalmente la configuración para 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 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 3: Definir una Cadena de Filtro¶

En este paso, se define la Cadena de filtro de una consultar utilizando los campos de objeto disponibles y la configuración de consultar. 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ásico o Avanzado.

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

  

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

    • Buscar: Ingrese 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 enumerados 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 clase de objeto: Cuando utilice el cuadro de búsqueda para filtrar, puede utilizar esta casilla de verificación para seleccionar todos los campos visibles a la vez.

    • Seleccionar campos: Seleccione las casillas de verificación 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 de verificación principal.

  • Tamaño de página: Ingrese el número máximo de resultados para recuperar para cada página en la respuesta a la consultar. Si se deja vacía, 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 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: Ingrese términos de búsqueda para consultar objetos en la clase de objeto seleccionada. El extremo de OData controla cómo se interpreta la búsqueda de una clase de objeto.

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

  • Arriba: Ingrese el número máximo de resultados a recibir en la respuesta a 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
      Iguales
      Mayor que
      Mayor o igual que
      Menos de
      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 un nuevo condicional a la tabla Cláusulas condicionales y a Cadena de filtro.

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

  • Cadena de filtro: A medida que completa los otros 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, condiciones y opciones de consultar seleccionados.

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

  

  • Tamaño de página: Ingrese el número máximo de resultados para recuperar para cada página en la respuesta a la consultar. Si se deja vacía, 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 picadura 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 registros recuperados de la consultar. Si la consultar no es válida, se muestran mensajes de error relevantes. La consultar debe ser válida y validada a través de este botón para poder habilitar el botón Siguiente.

  

• Volver: Haga clic para almacenar temporalmente la configuración de este paso y volver al paso anterior.

• Siguiente: Haga clic para almacenar temporalmente la configuración para 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 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 extremo. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Esquema de datos: Este esquema de datos se hereda mediante transformaciones adyacentes y se muestra nuevamente durante asignación de transformación.

  Nota

  Los datos proporcionados 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 a la consultar
    item	Nodo que representa los elementos de respuesta
    Lista de objetos	Nodo que representa la lista de objetos (conjunto de entidades) desde la que se consulta; por ejemplo, el 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 a la consultar solicitada
    _odata.count	Cadena del campo de anotación OData con el recuento total de objetos devueltos por 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 objetos...	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 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 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. Consulte la documentación de la biblioteca para obtener información adicional sobre cómo se admite el protocolo OData. La información general sobre el protocolo OData también está disponible en sitio de documentación de OData.

• Actualizar: Haga clic en el icono de actualización o la palabra Actualizar 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 mismo esquema, como en una transformación adyacente.

• Volver: Haga clic para almacenar temporalmente la configuración de este paso y volver 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 pide que confirme que desea descartar los cambios.

Próximos Pasos¶

Después de configurar una actividad Query de OData, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujos de trabajo o en diferentes.

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

Las actividades de OData Query 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 usar la actividad con funciones de secuencias de comandos, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de secuencias de comandos.

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