Saltearse al contenido

MFilesComponent

Bienvenido al componente MFilesComponent. Este nodo funciona como un puente seguro entre Nappai y tu sistema de gestión documental M-Files. Su propósito principal es permitirte automatizar tareas clave relacionadas con tus documentos y objetos, como buscar archivos, subir nuevos registros, descargar documentos, gestionar cambios de versión y realizar otras administraciones de contenido directamente desde tus flujos de trabajo en Nappai.

¿Cómo funciona?

Este componente se conecta directamente a la API de M-Files utilizando la configuración que definas. Una vez que proporcionas tus credenciales, Nappai puede comunicarse de forma segura con tu repositorio de documentos.

El componente actúa según la acción que selecciones:

  • Si necesitas buscar, utiliza los criterios definidos para explorar tu repositorio y devolverte información sobre los documentos encontrados.
  • Si deseas subir o descargar, interactúa con archivos externos o URLs para mover contenido hacia o desde M-Files.
  • Para operaciones de versión, puedes bloquear, desbloquear y registrar cambios en los documentos, manteniendo un historial ordenado.

Todos los resultados obtenidos se devuelven en un formato fácil de utilizar para el siguiente paso de tu flujo, permitiéndote conectar este nodo con otros componentes de automatización.

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 M-Files y guarda los campos requeridos (como la Base URL, Usuario, Contraseña y Vault GUID).
  3. En tu flujo de trabajo, selecciona la credencial guardada en el campo Credential de este componente.

Nota: Asegúrate de que el usuario configurado en la credencial tenga los permisos adecuados en M-Files para realizar las acciones que necesitas (buscar, subir, editar, etc.).

Entradas

Campos de Entrada

Los siguientes campos están disponibles para configurar este componente. Completa solo los campos que necesites según la operación que vayas a realizar.

  • Operation: Selecciona la acción principal que deseas realizar (por ejemplo, buscar, cargar, descargar, etc.).
  • Search By: Elige cómo deseas buscar: por nombre (texto completo) o por identificador de objeto.
  • Search Query: Escribe el texto que deseas buscar en los metadatos de M-Files.
  • Limit: Define el número máximo de resultados que quieres obtener. Útil para evitar devolver listas demasiado largas.
  • Mode: Elige si ingresarás el ID del objeto manualmente o si lo seleccionarás desde una lista desplegable cargada del repositorio.
  • Object Type: Selecciona el tipo de objeto en M-Files que estás buscando o gestionando. Usa el botón de refrescar para actualizar la lista si es necesario.
  • Object ID: Ingresa el identificador numérico del objeto en M-Files. Requiere que el ID sea un número entero.
  • Object: Permite seleccionar un objeto específico del repositorio de M-Files, filtrado por su tipo.
  • File ID: Si descargas un documento, puedes especificar el ID de un archivo concreto. Si lo dejas vacío, se usará el primer archivo adjunto al objeto.
  • File URL: Ingresa la URL (enlace web) del archivo que deseas subir. Acepta enlaces HTTP/HTTPS o datos en base64.
  • Document Title: Escribe el título que tendrá el nuevo documento en M-Files. Si lo dejas vacío, se usará el nombre del archivo por defecto.
  • Check-in Comment: Escribe un comentario opcional describiendo los cambios realizados en la versión del documento.

Salidas

Descripción de Salidas

  • Data: Contiene el resultado de la operación realizada. Dependiendo de la acción (búsqueda, carga, descarga, etc.), esta salida tendrá información detallada sobre los objetos encontrados, metadatos del documento, o confirmación del éxito de la acción. Puedes mapear esta salida en otros nodos para seguir procesando la información.

Ejemplo de Respuesta JSON

A continuación, se muestra un ejemplo de cómo se ve la estructura de datos que recibirás en la salida Data tras realizar una búsqueda exitosa. Esto te ayudará a identificar qué variables puedes usar en los siguientes pasos de tu flujo: json { “result”: “Success”, “count”: 2, “objects”: [ { “id”: 1001, “name”: “Contrato_Cliente_A.pdf”, “type”: “Contract”, “metadata”: { “Client”: “Acme Corp”, “Date”: “2023-10-01”, “Status”: “Active” } }, { “id”: 1002, “name”: “Presupuesto_v2.xlsx”, “type”: “Invoice”, “metadata”: { “Amount”: “5000”, “Reviewer”: “Maria G.”, “PendingApproval”: true } } ], “metadata”: { “operationType”: “search”, “timestamp”: “2023-10-27T10:30:00Z” } }

Conectividad

Este componente es versátil y se integra naturalmente en flujos de gestión documental. Lógicamente, su salida Data suele conectarse a:

  • Nodos de procesamiento de datos: Para filtrar, transformar o analizar los metadatos de los documentos encontrados.
  • Nodos de descarga o manipulación de archivos: Donde se usa la información devuelta para obtener los archivos reales.
  • Nodos de notificación o reportes: Para enviar resúmenes de búsquedas o confirmaciones de carga a usuarios o sistemas externos.
  • Nodos condicionales: Para tomar decisiones basadas en si se encontró un documento específico o para validar permisos antes de realizar cambios.

Ejemplo de Uso

Imagina que necesitas localizar todos los contratos de un cliente específico y luego descargarlos para archivarlos en una carpeta compartida.

  1. Configuras el campo Operation para buscar documentos.
  2. En Search By, eliges buscar por nombre y en Search Query escribes “Contrato Acme”.
  3. En Limit, estableces un valor como 10 para obtener solo los primeros 10 resultados.
  4. Al ejecutar el flujo, el componente devuelve una lista de contratos en Data.
  5. Conectas este nodo a un componente de descarga y mapeas la lista de IDs para obtener los archivos físicos automáticamente.

Consejos y Mejores Prácticas

  • Fase de Desarrollo Activo: Este componente se encuentra en una etapa activa de desarrollo. Se recomienda probar su comportamiento en un entorno de prueba antes de utilizarlo en flujos críticos de producción, ya que podrían haber ajustes menores en su comportamiento.
  • Gestión de Límites: Al realizar búsquedas, utiliza el campo Limit para controlar el volumen de resultados. Esto ayuda a mantener el rendimiento del flujo estable y evita sobrecargas innecesarias.
  • Comentarios en Versiones: Cuando trabajes con operaciones de check-in, siempre agrega un Check-in Comment. Esto es muy útil para llevar un registro claro de los cambios realizados en cada versión del documento.
  • Actualización de Tipos: Los tipos de objetos y las listas desplegables se cargan desde tu repositorio. Si agregas nuevos tipos en M-Files, recuerda usar el botón de refrescar en la interfaz para que aparezcan disponibles.
  • Manejo de Errores: Si una operación falla, el componente devuelve información detallada en Data que te ayudará a diagnosticar el problema. Revisa siempre los mensajes de error para ajustar tus parámetros o credenciales.

Consideraciones de Seguridad

  • Credenciales Seguras: Nunca compartas ni expongas las credenciales de M-Files. Úsalas siempre a través del gestor de credenciales de Nappai.
  • Permisos de Usuario: Asegúrate de que el usuario autenticado tenga los permisos adecuados. Intentar operaciones sin los permisos necesarios generará errores que podrán ser rastreados desde el registro de seguridad de M-Files.
  • Protocolo Seguro: Verifica que la conexión a M-Files utilize HTTPS para garantizar la encriptación de los datos en tránsito.