Saltearse al contenido
Nappai Documentation

SharePointSitesComponent

Este componente actúa como un puente seguro entre tu sistema de automatización Nappai y Microsoft SharePoint. Te permite buscar, recuperar y administrar sitios de forma intuitiva, integrando automáticamente los datos obtenidos en tus flujos de trabajo sin necesidad de escribir código.

¿Cómo funciona?

Al configurar este componente, Nappai se comunica de forma segura con los servidores de Microsoft SharePoint a través de su API oficial. Dependiendo de la operación que elijas, el componente buscará sitios específicos, devolverá una lista completa o recuperará detalles de un sitio concreto. Una vez obtenida la información, los resultados se preparan automáticamente en un formato estructurado para que puedas usarlos en los siguientes pasos de tu automatización, ya sea para filtrar datos, notificar a usuarios o actualizar otras aplicaciones.

Conexión y Credenciales

Este componente requiere configurar previamente una credencial en el panel de Nappai para poder interactuar con el servicio externo:

  1. Dirígete a la sección de Credenciales en tu panel de Nappai.
  2. Crea una nueva credencial del tipo Microsoft Shared Point y guarda los campos requeridos (Client ID, Client Secret, Tenant ID y Microsoft Shared Point Scope). Puedes gestionar estos accesos en Microsoft Entra.
  3. En tu flujo de trabajo, selecciona la credencial guardada en el campo de entrada Credential de este nodo.

Operaciones

Este componente ofrece varias operaciones que puedes seleccionar según lo que necesites hacer. Solo puedes usar una operación a la vez:

  • Get All Sites: Recupera una lista completa de todos los sitios de SharePoint a los que tienes acceso.
  • Search Sites: Busca sitios específicos utilizando palabras clave, etiquetas o filtros estructurados.
  • Get Site by ID or Name: Obtiene los detalles y la configuración de un sitio concreto identificándolo por su identificador único o nombre.
  • Get Root Site: Localiza y devuelve la configuración del sitio raíz principal de tu entorno de SharePoint.
  • Get Site Drives: Recupera las unidades de almacenamiento (discos virtuales) asociadas a un sitio específico.

Para usar el componente, primero selecciona la operación que necesitas en el campo “Operation” (Operación).

Entradas

Modo de Mapeo (Mapping Mode)

Este componente cuenta con un modo especial llamado “Mapping Mode” (Modo de Mapeo). Cuando activas este modo mediante el interruptor, se habilita una entrada adicional llamada “Mapping Data” y cada campo de entrada te ofrece tres formas diferentes de proporcionar datos:

  • Fixed (Fijo): Escribes el valor directamente en el campo.
  • Mapped (Mapeado): Conectas la salida de otro componente para usar su resultado como valor.
  • Javascript: Escribes código Javascript para calcular el valor dinámicamente.

Esta flexibilidad te permite crear flujos de trabajo más dinámicos y conectados.

Campos de Entrada

Los siguientes campos están disponibles para configurar este componente. Cada campo puede estar visible en diferentes operaciones:

  • Operation: Selecciona la acción que deseas realizar con los sitios de SharePoint.

    • Visible en: Get All Sites, Search Sites, Get Site by ID or Name, Get Root Site, Get Site Drives

  • Hostname: Indica el nombre de dominio o host de tu entorno de SharePoint (por ejemplo, empresa.sharepoint.com).

    • Visible en: Get Site by ID or Name

  • Mapping Mode: Activa el modo especial para procesar múltiples registros de datos en lote y conectar salidas dinámicamente.

    • Visible en: Get All Sites, Search Sites, Get Site by ID or Name, Get Root Site, Get Site Drives

  • Results Count: Define la cantidad máxima de resultados que deseas recibir (por defecto: 50).

    • Visible en: Get All Sites, Search Sites, Get Site by ID or Name

  • Search Query: Escribe el término de búsqueda para encontrar sitios de SharePoint. Usa palabras clave simples o consultas estructuradas. Ejemplos: * (todos los sitios), project (busca “project” en nombre o descripción), displayName:Reports (busca sitios con nombre “Reports”).

    • Visible en: Search Sites, Get Site by ID or Name

  • Site ID or Name: Ingresa el identificador único o el nombre exacto del sitio de SharePoint que deseas consultar.

    • Visible en: Get Site by ID or Name, Get Site Drives

  • Site Path: Especifica la ruta relativa del sitio dentro de la jerarquía de SharePoint (por ejemplo, /sites/teamsite).

    • Visible en: Get Site by ID or Name

Salidas

Al ejecutar el componente, recibirás la información en formato estructurado listo para ser utilizado en los siguientes pasos de tu automatización. La información principal se devuelve como un conjunto de datos que incluye detalles como IDs, URLs, títulos y metadatos del sitio, junto con un indicador de estado para confirmar si la operación se completó correctamente. En caso de error, recibirás un mensaje descriptivo que te ayudará a solucionar el problema.

Ejemplo de Respuesta JSONjson

{ “Data”: [ { “id”: “c4f2a8b1-9e3d-4f1a-b7c6-5d8e9f0a1b2c”, “displayName”: “Proyecto Alpha”, “url”: “https://contoso.sharepoint.com/sites/Alpha”, “state”: “active”, “createdDateTime”: “2023-10-15T08:30:00Z” } ], “status”: “success”, “error”: null }

Conectividad

Una vez que este componente recupera los datos de SharePoint, es común conectarlo con otros nodos para continuar el flujo de trabajo. Lógicamente, sus salidas suelen enlazarse con:

  • Componentes de filtrado y transformación: Para seleccionar solo los registros que necesitas o reorganizar los datos.
  • Aprobadores o gestores de tareas: Para enviar la información obtenida a responsables para su revisión.
  • Notificaciones: Para alertar a equipos sobre nuevos sitios creados o cambios detectados.
  • Otros componentes de Microsoft: Como listas, archivos o usuarios, para sincronizar información y mantener tus datos actualizados entre aplicaciones.

Ejemplo de Uso

Escenario: Automatización de reportes mensuales Imagina que necesitas revisar qué sitios de SharePoint tienen actividad reciente y notificar a los responsables.

  1. Añades este componente y seleccionas la operación Search Sites.
  2. En Search Query, escribes proyecto para encontrar sitios relacionados.
  3. Activas Mapping Mode para que el componente pueda procesar varios resultados a la vez.
  4. Conectas la salida a un nodo de Filtrado que solo mantenga los sitios creados en el último mes.
  5. Finalmente, envías los resultados a un nodo de Correo Electrónico para avisar a los administradores. Así, en lugar de buscar manualmente cada sitio en SharePoint, la automatización se encarga de reunir y organizar la información.

Notas Importantes

🔒 Deletion Requires Careful Permission Checks 🔴 La operación de eliminación elimina permanentemente un sitio y todo su contenido. Verifica que cuentas con los permisos adecuados y realiza copias de seguridad antes de ejecutar esta acción.

⚠️ Component in Development 🔴 SharePointSitesComponent se encuentra en fase de desarrollo. Algunas funciones pueden estar incompletas, ser inestables o comportarse de manera inesperada. Úsalo con precaución y pruébalo exhaustivamente antes de implementarlo en un entorno de producción.

📋 Microsoft SharePoint Credentials Needed 🟡 Para utilizar este componente debes proporcionar credenciales válidas de SharePoint (por ejemplo, un token de autenticación) y contar con los permisos de API necesarios para recuperar, actualizar y eliminar sitios.

💡 Use Specific Queries for Retrieval 🟢 Al recuperar sitios, incluye filtros específicos o parámetros de consulta en lugar de solicitudes amplias. Esto reduce la carga en los servidores de SharePoint y acelera los tiempos de respuesta.

⚙️ Ensure Proper Field Mapping 🟡 Al configurar el componente, verifica que todos los campos requeridos estén mapeados correctamente. Los errores de coincidencia pueden provocar fallos durante las operaciones de actualización o eliminación de sitios.

ℹ️ Mapping Mode Is Enabled by Default 🟢 El componente funciona en modo de mapeo, lo que significa que espera que los campos de entrada se asignen explícitamente a los nombres de campo de SharePoint. Un mapeo incorrecto puede generar errores o actualizaciones incompletas.

Consejos y Mejores Prácticas

  • Comienza siempre con una operación de búsqueda (Search Sites) con filtros específicos para evitar sobrecargar el sistema.
  • Utiliza el modo de mapeo (Mapping Mode) cuando necesites procesar varios registros a la vez; esto agiliza la automatización.
  • Verifica los permisos de tu credencial antes de intentar actualizar o eliminar sitios, ya que la falta de acceso puede detener el flujo.
  • Usa nombres claros y consistentes para tus sitios en SharePoint, facilitando así su recuperación posterior mediante Search Query o Site ID.
  • Revisa la documentación oficial de Microsoft en Entra ID si encuentras errores de conexión o autenticación.

Consideraciones de Seguridad

  • Al utilizar operaciones que modifican o eliminan datos, asegúrate de tener respaldos actualizados y los permisos correctos.
  • Nunca compartas credenciales en textos no seguros; utiliza siempre el panel de credenciales de Nappai.
  • Revisa los logs de errores del componente si una operación falla; generalmente indican si el problema es de acceso, permisos o formato de solicitud.
  • Limita el alcance de las consultas a lo necesario para proteger la privacidad y seguridad de la información corporativa almacenada en SharePoint.