Document
El componente Document es tu puente seguro para trabajar con archivos de Microsoft Word almacenados en la nube (como OneDrive o SharePoint). En lugar de abrir Word manualmente, puedes usar este nodo para que el sistema lea, busque, reemplace, inserte o formatee texto, tablas e imágenes automáticamente. Es ideal para llenar plantillas, actualizar reportes o organizar información sensible dentro de tus flujos de automatización en Nappai.
¿Cómo funciona?
Este componente se conecta directamente a tus documentos de Word guardados en la nube. Cuando lo agregas a tu flujo, el sistema te pide los campos necesarios para identificar el archivo (como el ID del documento o la unidad de almacenamiento). Una vez identificado, puede realizar varias acciones de forma automática y en segundo plano:
- Leer o extraer todo el contenido o párrafos específicos.
- Buscar y reemplazar palabras o frases en el texto según reglas de coincidencia.
- Insertar nuevo texto, párrafos, tablas o imágenes en posiciones concretas.
- Aplicar formato como negritas, colores, tamaños de fuente o alineación.
Todo esto ocurre de manera segura y rápida, devolviendo el estado de la operación para que puedas conectar el resultado a otras partes de tu automatización sin necesidad de tocar el archivo manualmente.
Conexión y Credenciales
Este componente requiere configurar previamente una credencial en el panel de Nappai para poder interactuar con el servicio externo:
- Dirígete a la sección de Credenciales en tu panel de Nappai.
- Crea una nueva credencial del tipo Microsoft Word y guarda los campos requeridos (Client ID, Client Secret, Tenant ID y Microsoft Word Scope) según las instrucciones de tu administrador de Microsoft Entra.
- En tu flujo de trabajo, selecciona la credencial guardada en el campo de entrada Credential de este nodo.
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:
- Selection Mode: Define cómo se identificará el contenido a modificar (por índice, por palabra o por rango).
- Visible en: Configuración general
- Select Documents: Permite seleccionar documentos desde tu OneDrive predeterminado.
- Visible en: Configuración general
- Document ID: Identificador único del archivo .docx que deseas leer o editar.
- Visible en: Configuración general
- Drive ID: ID de la unidad de almacenamiento de OneDrive o SharePoint. Si no se proporciona, se usará la predeterminada.
- Visible en: Configuración general
- Document Content: Texto completo o fragmento para reemplazar o escribir en el documento.
- Visible en: Configuración general
- Paragraph Text: Texto específico que se insertará como un nuevo párrafo.
- Visible en: Configuración general
- Text Content: Texto objetivo para insertar en una posición específica del documento.
- Visible en: Configuración general
- Insert Position: Indica dónde colocar el nuevo contenido (inicio, final, después de un texto específico, etc.).
- Visible en: Configuración general
- Search Text: Palabra o frase que deseas localizar dentro del documento.
- Visible en: Configuración general
- Replace Text: Nuevo texto que reemplazará a lo encontrado.
- Visible en: Configuración general
- Replace Mode: Controla cómo se realiza la búsqueda y sustitución (respetar mayúsculas, palabra completa, etc.).
- Visible en: Configuración general
- Table Data: Estructura de filas y columnas para crear o actualizar tablas dentro del documento.
- Visible en: Configuración general
- Formatting Options: Ajustes de estilo como negrita, cursiva, color, tamaño de fuente o alineación.
- Visible en: Configuración general
- Image URL: Enlace o ruta para incrustar una imagen en el documento.
- Visible en: Configuración general
- Image Description: Texto alternativo para la imagen (útil para accesibilidad y contexto).
- Visible en: Configuración general
- Bulk Text Operations: Lista de operaciones de texto secuenciales para ejecutar múltiples cambios a la vez.
- Visible en: Configuración general
- Content Format: Formato del contenido extraído o devuelto (texto plano, HTML, Markdown, etc.).
- Visible en: Configuración general
- Paragraph Index: Número de posición del párrafo objetivo para operaciones específicas (empieza en 0).
- Visible en: Configuración general
Salidas
Al finalizar su ejecución, este componente devuelve un resultado estructurado en el campo Data. Este valor contiene la información sobre el estado de la operación, el contenido del documento si se solicitó, y metadatos sobre los cambios realizados (como párrafos actualizados, imágenes insertadas o cantidad de operaciones ejecutadas). Puedes mapear esta salida para alimentar otros nodos, validar el éxito de la automatización o extraer información para reportes posteriores.
Ejemplo de Respuesta JSONjson
{ “success”: true, “document_content”: “El informe final del cliente ha sido generado correctamente…”, “updated_paragraphs”: [ { “index”: 0, “content”: “Datos de ventas actualizados”, “status”: “modified” } ], “table_results”: [ { “rows”: 3, “columns”: 2, “status”: “created” } ], “images_processed”: [ { “url”: “https://example.com/logo.png”, “description”: “Logo oficial”, “status”: “inserted” } ], “operation_count”: 2, “error_message”: null }
Conectividad
Este componente suele funcionar como un eslabón central en flujos de gestión documental. Generalmente:
- Recibe datos de nodos que extraen información, consultan bases de datos, leen formularios web o descargan archivos.
- Envía su salida a nodos que generan reportes finales, envían correos electrónicos con el documento procesado, guardan archivos en otras ubicaciones o validan el cumplimiento de procesos. Su diseño permite encajar perfectamente en cadenas que van desde la extracción de datos crudos hasta la generación de documentos finales listos para distribución, actuando como el motor de edición inteligente del flujo.
Ejemplo de Uso
Imagina que necesitas actualizar mensualmente las cifras de ventas en una plantilla de reporte de Microsoft Word.
- Conectas el componente Document a un nodo que extrae los datos de ventas de una base de datos o CRM.
- En los campos del componente, seleccionas el archivo de plantilla (
Select Documents), defines elDocument IDy activas Mapping Mode para vincular los datos extraídos a los camposSearch TextyReplace Text. - Al ejecutar el flujo, el componente busca automáticamente las cifras viejas en la plantilla, las reemplaza con las nuevas, guarda los cambios y devuelve un estado de éxito en su salida
Data. - El siguiente nodo en tu flujo (por ejemplo, “Enviar Email”) recibe el documento actualizado y lo adjunta automáticamente al correo del equipo de ventas.
Consejos y Mejores Prácticas
- Usa Mapping Mode siempre que los datos provengan de otros nodos del flujo; evita escribir valores fijos para mantener la automatización dinámica y reutilizable.
- Define claramente el Selection Mode y el Paragraph Index cuando trabajes con documentos largos para evitar que el componente edite el texto incorrecto.
- Para operaciones repetitivas, activa Bulk Text Operations en lugar de crear múltiples nodos separados, lo que optimiza el rendimiento y simplifica tu flujo visual.
- Verifica siempre que las URLs de imágenes en Image URL sean públicas o accesibles, ya que el componente las descargará directamente desde la red.
- Revisa el
operation_counten la salida para confirmar que se ejecutaron todas las operaciones esperadas, especialmente en flujos de gran volumen.
Consideraciones de Seguridad
- Asegúrate de que la credencial de Microsoft Word tenga los permisos mínimos necesarios (solo lectura/escritura sobre los documentos específicos que necesites).
- No compartas IDs de documentos (
Document ID) o credenciales en canales públicos; utilízalos únicamente dentro de flujos autenticados de Nappai. - Si el documento contiene información sensible, valida que las operaciones de búsqueda y reemplazo estén bien configuradas para evitar sobrescrituras accidentales de datos críticos.
- Revisa el campo
operation_counten la salida para confirmar que se ejecutaron todas las operaciones esperadas, especialmente en flujos de gran volumen. - Mantén las credenciales actualizadas y rotadas según las políticas de tu organización; cualquier cambio en Microsoft Entra puede afectar temporalmente la conexión del componente.