Saltearse al contenido
Nappai Documentation

OpenKM Documents

Bienvenido al componente OpenKM Documents de Nappai. Este es tu puente seguro para interactuar con OpenKM, tu Sistema de Gestión Documental (DMS).

Utiliza este componente para automatizar tareas como subir archivos, buscar documentos, organizarlos en carpetas, cambiar sus nombres y mantener un control estricto sobre las versiones (historial de cambios). Es ideal para flujos de trabajo que requieren gestionar facturas, contratos o archivos de clientes de manera centralizada y segura.

¿Cómo funciona?

Este componente funciona como un “asistente virtual” que habla el idioma de OpenKM. Cuando lo conectas a tu flujo de trabajo en Nappai, el componente utiliza tus credenciales de seguridad para acceder a tu repositorio de documentos y realiza la acción que le indiques (como subir un archivo o verificar una versión).

Integración con OpenKM: El componente se conecta directamente a la API de OpenKM para ejecutar las operaciones. Esto significa que los cambios que hagas aquí (como mover un archivo) se reflejan inmediatamente en tu sistema de gestión documental real. El sistema maneja automáticamente la comunicación segura, permitiéndote concentrarte en qué necesitas hacer con los documentos sin preocuparte por la complejidad técnica de la conexión.

Conexión y Credenciales

Para que este componente pueda acceder a tus documentos, es necesario configurar una conexión segura primero.

  1. Dirígete a la sección de Credenciales en tu panel de Nappai.
  2. Crea una nueva credencial del tipo OpenKM y guarda los datos requeridos (URL Base, Usuario y Contraseña).
  3. En tu flujo de trabajo, selecciona la credencial guardada en el campo de entrada Credential de este componente.

Nota: Sin esta credencial configurada, el componente no podrá ver ni modificar tus documentos.

Entradas

Los siguientes campos están disponibles para configurar este componente. Estos campos te permiten definir qué documento quieres tocar y qué quieres hacer con él.

  • Operation: Selecciona la acción específica que deseas realizar con el documento. Las opciones principales incluyen:

    • Check Out: Bloquea el documento para que solo tú puedas editarlo.
    • Check In: Guarda los cambios realizados en el documento (crear una nueva versión).
    • Delete: Elimina el documento del sistema.
    • Download: Descarga el contenido del documento para su uso en otros pasos.
    • Get Properties: Obtiene información sobre el documento (quién lo creó, fecha, etc.).
    • Move: Mueve el documento a otra carpeta.
    • Rename: Cambia el nombre del archivo.
    • Search: Busca documentos basándose en filtros.
    • Upload: Sube un nuevo archivo al repositorio.

  • Document UUID: El identificador único (UUID) o la ruta completa del documento al que quieres aplicar la acción. Es esencial para saber exactamente qué archivo estás tocando.

    • Visible en: Check Out, Check In, Delete, Download, Get Properties, Move, Rename, Search

  • Parent Folder UUID: El UUID de la carpeta donde se subirá el documento. Solo es necesario si estás subiendo un archivo nuevo.

    • Visible en: Upload

  • File URL: La dirección web (URL) del archivo que deseas subir o la que se usará para actualizar una versión.

    • Visible en: Upload, Check In

  • Document Name: El nombre que quieres darle al documento dentro de OpenKM. Si lo dejas vacío, el sistema usará el nombre original del archivo.

    • Visible en: Upload, Rename

  • Destination Folder: La carpeta de destino (UUID o ruta) donde moverás el documento.

    • Visible en: Move

  • New Name: El nuevo nombre para el documento.

    • Visible en: Rename

  • Version Comment: Una nota breve explicando qué cambios hiciste en esta versión. Ayuda a recordar por qué se hicieron cambios en el futuro.

    • Visible en: Check In

  • Increment: Define qué tipo de número de versión se crea (Ninguno, Menor como 0.1, o Mayor como 1.0).

    • Visible en: Check In

  • Limit: El número máximo de resultados que quieres obtener en una búsqueda.

    • Visible en: Search

  • Add Search Filter: Selecciona filtros adicionales para refinar tu búsqueda (por ejemplo, buscar por autor o fecha).

    • Visible en: Search

Salidas

Cuando el componente termina de ejecutar una acción, te devuelve información importante para continuar tu flujo de trabajo.

  • Data: Contiene la información resultante de la operación. Por ejemplo, si descargaste un archivo, aquí estará el contenido; si buscaste documentos, aquí estará la lista de resultados.

Ejemplo de Respuesta JSON

A continuación, un ejemplo de cómo se ve la información que podrías recibir después de buscar documentos o verificar propiedades: json { “document_metadata”: { “title”: “Contrato_Cliente_X”, “created”: “2023-10-15T10:00:00”, “modified”: “2023-10-20T14:30:00”, “owner”: “admin” }, “success”: true, “message”: “Operación realizada con éxito” }

Conectividad

Este componente suele actuar como un “centro de distribución” para tus archivos en el flujo de trabajo:

  • Conexión hacia el Componente: Generalmente recibe flujos de trabajo que necesitan procesar archivos (por ejemplo, tras recibir un email con un adjunto, podrías usar este componente para guardarlo en OpenKM).
  • Conexión desde el Componente: Es común que los documentos que subes (Upload) o modificas (Check In) se conecten luego a un componente de Email o Notificación para avisar a los usuarios que el archivo ya está disponible. Asimismo, las salidas de Search suelen conectarse a componentes de Lógica (If/Else) para decidir qué hacer con los documentos encontrados.

Ejemplo de Uso

Escenario: Automatización de Archivos de Facturas

  1. Obtención: El componente Email recibe una factura en PDF y envía su URL al flujo.
  2. Gestión: Conectas el OpenKM Documents en la operación Upload.
    • En Document Name, escribes “Factura_2023_001”.
    • En Parent Folder UUID, seleccionas la carpeta “Facturas”.
  3. Resultado: La factura se guarda en tu repositorio seguro y el flujo continua confirmando el almacenamiento.

Consejos y Mejores Prácticas

  • Usa UUIDs: Si es posible, utiliza el identificador único (UUID) del documento en lugar de la ruta de texto, ya que es menos propenso a errores si mueves la carpeta de origen.
  • Comentarios en Versiones: Siempre llena el campo Version Comment al subir cambios, así tendrás un historial claro de qué se modificó y por qué.
  • Bloqueo de Archivos: Usa la operación Check Out antes de editar un documento compartido para evitar que otra persona guarde cambios encima de los tuyos.

Consideraciones de Seguridad

  • Acceso Restringido: Este componente solo puede ver y modificar documentos a los que la cuenta de usuario (definida en la credencial) tenga permisos. Si no tienes permiso de lectura, el componente devolverá un error.
  • Eliminación Permanente: Ten precaución con la operación Delete, ya que generalmente elimina el documento del repositorio de forma irreversible. Asegúrate de tener copias de seguridad si es necesario.
  • Manejo de Credenciales: Nunca compartas el usuario y contraseña de tu credencial de OpenKM públicamente. Nappai protege estos datos de forma segura.