Actividad de Consulta de Microsoft SharePoint 365

Introducción

Una actividad de Consulta de Microsoft SharePoint 365, utilizando su conexión de Microsoft SharePoint 365, consulta datos de objetos en Microsoft SharePoint 365 y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.

Crear una actividad de Consulta de Microsoft SharePoint 365

Una instancia de una actividad de Consulta de Microsoft SharePoint 365 se crea a partir de una conexión de Microsoft SharePoint 365 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 de Microsoft SharePoint 365 existente se puede editar desde estas ubicaciones:

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

Configurar una actividad de Consulta de Microsoft SharePoint 365

Siga estos pasos para configurar una actividad de Consulta de Microsoft SharePoint 365:

• Paso 1: Ingrese un nombre y seleccione un objeto
  Proporcione un nombre para la actividad y seleccione un objeto.

• Paso 2: Seleccione objetos secundarios
  Especifique los objetos secundarios seleccionados.

• Paso 3: Defina una cadena de filtro
  Establezca condiciones para una consulta sobre los objetos secundarios seleccionados.

• Paso 4: Revisar los esquemas de datos
  Se muestran los esquemas de solicitud o respuesta.

Paso 1: Ingresar un nombre y seleccionar un objeto

En este paso, proporciona un nombre para la actividad y selecciona un objeto. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Consulta de Microsoft SharePoint 365 y no debe contener barras diagonales / ni dos puntos :.

• Seleccionar Objeto: Esta sección muestra los objetos disponibles en el punto final de Microsoft SharePoint 365.

  • Objeto Seleccionado: Después de seleccionar un 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 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 o en la palabra Actualizar para recargar objetos desde el punto final de Microsoft SharePoint 365. Esto puede ser útil si se han agregado objetos a Microsoft SharePoint 365. 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, haz clic en cualquier parte de una fila para seleccionar un objeto. Solo se puede seleccionar un objeto. La información disponible para cada objeto se obtiene del punto final de Microsoft SharePoint 365:

    • Nombre: El nombre del objeto de Microsoft SharePoint 365.

    • Tipo: El tipo de objeto de Microsoft SharePoint 365.

    • Descripción: La descripción del objeto de Microsoft SharePoint 365.

  Consejo

  Si la tabla no se llena con los objetos disponibles, la conexión de Microsoft SharePoint 365 puede no ser exitosa. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

• 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 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 2: Seleccionar objetos secundarios

En este paso, seleccione cualquier objeto secundario. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Clases de Objetos: Esta sección muestra las clases de objetos secundarios disponibles y seleccionadas para interactuar con el punto final de Microsoft SharePoint 365.

  • Objetos Secundarios Disponibles: Esta sección muestra una lista de clases de objetos secundarios disponibles en Microsoft SharePoint 365.

    • Buscar: Ingrese 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 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 punto final al buscar, ingrese criterios de búsqueda y luego actualice, como se describe a continuación.

    • Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para recargar objetos desde el punto final de Microsoft SharePoint 365. Esto puede ser útil si se han agregado objetos a Microsoft SharePoint 365. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrada en la configuración.

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

  • Objetos Hijos Seleccionados: Después de agregar una clase de objeto hijo, se lista aquí.

    • Eliminar un Objeto Hijo: Dentro de la columna Objeto Hijo Seleccionado, haz clic en cualquier parte de una fila para seleccionar una o más clases de objetos hijos. Luego, haz clic en el ícono de eliminar para devolver las clases seleccionadas a la columna Objetos Hijos 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 interfaz utilizada en este paso de la configuración de una actividad de Consulta de Microsoft SharePoint 365 depende de la pestaña seleccionada:

• Básico: Esta opción te permite construir la Cadena de Filtro con campos guiados.

• Avanzado: Esta opción oculta los campos guiados y te permite modificar la Cadena de Filtro directamente.

Básico

Si se selecciona la pestaña Básico, se presenta esta interfaz:

• 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 endpoint de Microsoft SharePoint 365.

  • Seleccionar Todo en Clase de Objeto: Al usar el cuadro de búsqueda para filtrar, puedes usar 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 un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página totalizará hasta el tamaño especificado. También se incluirá un enlace a la siguiente página de resultados en la respuesta.

  • Incluir Conteo: Selecciona incluir el número de resultados de una consulta como parte de la respuesta.

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

  • Omitir: Ingresa un número de resultados a omitir en la respuesta de la consulta.

  • Máximo: Ingresa un número máximo de resultados a recibir en la respuesta de la consulta.

  • 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: Usa el menú desplegable para seleccionar la clase de objeto que se utilizará para el condicional.

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

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

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

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

    • Eliminar: Haz clic en el ícono de eliminar para quitar la condición de la tabla.

    • Agregar: Haz clic para añadir una nueva condición a la tabla y Cadena de Filtro.

    • Eliminar Todo: Haz clic para eliminar todas las condiciones de la tabla 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 llena automáticamente con los campos seleccionados, condiciones y opciones de consulta.

• 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.

  Nota

  Debido a una limitación en el Protocolo OData v4, una consulta válida que no devuelve resultados tiene una tabla vacía y no muestra un mensaje de error.

• 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 pide que confirmes que deseas descartar los cambios.

Avanzado

Si se selecciona la pestaña Avanzado, se presenta esta interfaz:

• Tamaño de Página: Ingresa un tamaño de página para habilitar la paginación de resultados. El número de resultados en una página totalizará el tamaño especificado. También se incluirá un enlace a la siguiente página de resultados en la respuesta.

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

• Consulta de Prueba: 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.

  Nota

  Debido a una limitación en el Protocolo OData v4, una consulta válida que no devuelve resultados tiene una tabla vacía y no muestra un mensaje de error.

• 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 pide que confirmes que deseas descartar los cambios.

Paso 4: Revisar los esquemas de datos

Se muestran los esquemas de solicitud o respuesta. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

• Esquemas de Datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.

  El conector de Microsoft SharePoint 365 utiliza el Protocolo OData v4. Consulta la documentación de la API para obtener información sobre los nodos y campos del esquema.

  La actividad Query utiliza JSON en su esquema de respuesta.

• Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el endpoint de Microsoft SharePoint 365. 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.

• Editar: Haz clic en el ícono de editar sobre cada esquema de datos para ingresar al editor. El editor te permite agregar, eliminar y reorganizar nodos y campos, así como cambiar sus tipos de datos. Todos los nodos y campos recién agregados se establecen en [0, 1] cardinalidad. Los cambios realizados en los esquemas de datos deben ser aceptables para el endpoint y deben hacerse solo después de consultar cualquier documentación disponible para el endpoint. Después de realizar ediciones en el esquema, se muestra una fecha de última edición en la parte superior del esquema aplicable para indicar que el esquema ha tenido ediciones manuales. Actualizar los esquemas restablecerá los esquemas a sus estructuras predeterminadas.

• 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 pide que confirmes que deseas descartar los cambios.

Próximos pasos

Después de configurar una actividad Query de Microsoft SharePoint 365, 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 de conectores.

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

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

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.