OpenKM Documents

OpenKM Documents conecta tu flujo con el gestor documental OpenKM para trabajar con documentos: subir uno nuevo a una carpeta, consultar sus propiedades, buscarlos por distintos criterios, moverlos, renombrarlos, bloquearlos para editarlos, guardar una versión nueva o eliminarlos.

Para crear y organizar carpetas usa OpenKM Folders.

Cuándo usarlo

Llegan facturas por correo y quieres guardarlas en la carpeta de facturas de OpenKM.
Quieres buscar los documentos de un autor o que contienen una palabra para revisarlos.
Un flujo genera una versión nueva de un contrato y quieres guardarla en OpenKM con un comentario.
Quieres mover a una carpeta de archivo los documentos de un expediente ya cerrado.
Un agente de IA necesita consultar las propiedades de un documento para responder a una pregunta.

Configuración

Necesitas una credencial OpenKM con la dirección de tu servidor, tu usuario y tu contraseña. Consulta Credenciales.

Campo	Qué hace
Credential (obligatorio)	La credencial OpenKM con la que se accede al gestor.
Operation (obligatorio)	Lo que hace el componente. Ver Operaciones. Por defecto, `Get Properties`.
Document UUID	El identificador o la ruta completa del documento. Obligatorio en todas las operaciones salvo `Upload Document` y `Search Documents`.
Parent Folder UUID	Solo en `Upload Document`. El identificador de la carpeta donde se guarda el documento. Obligatorio.
File URL	En `Upload Document`, la dirección pública del fichero que se sube (obligatorio). En `Checkin`, la dirección del fichero de la versión nueva. En los dos casos también admite el fichero codificado en Base64 como `data:`.
Document Name	Solo en `Upload Document`. El nombre del documento en OpenKM. Vacío, se toma de la dirección del fichero.
Destination Folder	Solo en `Move Document`. El identificador o la ruta de la carpeta de destino, por ejemplo `/okm:root/archivo`. Obligatorio.
New Name	Solo en `Rename Document`. El nombre nuevo. La extensión original del fichero se mantiene siempre. Obligatorio.
Version Comment	Solo en `Checkin`. Un comentario opcional que describe los cambios de la versión.
Increment	Solo en `Checkin`. Cómo cambia el número de versión: `0` no cambia, `1` versión menor (por ejemplo, de 1.0 a 1.1), `2` versión mayor (de 1.1 a 2.0). Por defecto, 1.
Limit	Solo en `Search Documents`. Número máximo de resultados. Por defecto, 10.
Add Search Filter	Solo en `Search Documents`. Añade un criterio de búsqueda. Cada filtro que eliges aparece como un campo nuevo con su nombre, donde escribes el valor; el icono de la papelera lo quita.

Operaciones

Operación	Qué hace
`Upload Document`	Sube un fichero a una carpeta y lo crea como documento.
`Get Properties`	Devuelve las propiedades que OpenKM guarda de un documento, como su ruta.
`Delete Document`	Elimina un documento.
`Move Document`	Mueve un documento a otra carpeta.
`Rename Document`	Cambia el nombre de un documento.
`Checkout`	Bloquea un documento para editarlo.
`Checkin`	Sube la versión nueva de un documento bloqueado, con su comentario, y lo desbloquea.
`Cancel Checkout`	Quita el bloqueo de un documento sin guardar cambios.
`Search Documents`	Busca documentos con los filtros que añadas.

Filtros de búsqueda

Los filtros de Add Search Filter usan los nombres de OpenKM. Los más habituales son name (nombre del documento), content (texto que contiene), title, author, keyword (palabras clave), category, folder (carpeta donde buscar), folderRecursive (true para incluir subcarpetas), mimeType (tipo de fichero), lastModifiedFrom y lastModifiedTo (fechas de modificación) y sortField con sortReverse (orden de los resultados). En keyword, category y property puedes escribir varios valores separados por comas.

Resultado

La salida Data devuelve lo que responde OpenKM. En Search Documents sale un elemento por cada documento encontrado, con sus propiedades. En Get Properties, las propiedades del documento. En el resto de operaciones, la confirmación de OpenKM o un resumen de lo hecho.

El componente también se puede conectar a un Agente como herramienta, para que el agente busque o archive documentos cuando lo necesite. Ver Tool Mode.

Ejemplo

Una gestoría quiere guardar en OpenKM las facturas que recibe por correo.

El flujo empieza con el correo que trae la factura adjunta.
Añade OpenKM Documents con la operación Upload Document.
En Parent Folder UUID pon el identificador de la carpeta de facturas y en File URL conecta la dirección del adjunto.
En Document Name escribe el nombre del proveedor seguido de la fecha.
Conecta Data a un componente de mensajería que avise al equipo de contabilidad.

Buenas prácticas

Para cambiar el contenido de un documento, haz primero Checkout y después Checkin con el fichero nuevo.
Añade solo los filtros que necesites: cada filtro con valor restringe más la búsqueda.
Si quieres encontrar una carpeta y su identificador, usa List Contents en OpenKM Folders.

Componentes relacionados

OpenKM Folders: crea, mueve, renombra y lista carpetas de OpenKM.