User guide

Invoice Capture es una aplicación web para gestionar facturas -normalmente documentos PDF- en OpenKM. Ayuda a enviar y recibir facturas relacionadas con una empresa y, eventualmente, a catalogarlas automáticamente.

Precaución

Actualmente están disponibles las traducciones en inglés y español, pero la aplicación se puede traducir fácilmente a otros idiomas.

Metadatos usados por el catálogo

La aplicación usa metadatos en combinación con Automatización para catalogar facturas automáticamente.

La aplicación puede crear distintos tipos de documentos -facturas, albaranes, etc.- creando distintos grupos de metadatos que se cargan dinámicamente en el formulario de entrada de datos.

Algunos de los campos de metadatos por defecto son:

• NIF de la empresa (obligatorio)
• Nombre de la empresa (obligatorio)
• Código interno de la empresa (no obligatorio)
• Número de factura (no obligatorio)
• Estado de la factura (valores posibles: enviada, recibida, etc.)
• Fecha (obligatorio)
• Usuario
• IVA
• Coste total

Nota

Las facturas se catalogan en OpenKM por defecto con la siguiente estructura de carpetas: /okm:root/{root.destination.folder}/{tax number}/{year}/{month}, donde {tax number}, {year} y {month} corresponden a los valores de los campos de metadatos.

La propiedad root.destination.folder se establece en el fichero llamado invoice-capture.properties. Ahí se indica directamente el nombre de la carpeta.

Preliminares de configuración

Los roles que usa la aplicación son:

• ROLE_ADMIN
• ROLE_STANDARD
• ROLE_ADVANCED

Crear los roles que falten

Vaya a OpenKM Administración > Autenticación > Roles

• ROLE_STANDARD
• ROLE_ADVANCED

Nota

Use una cuenta de usuario con ROLE_ADMIN para:

• Crear empresas.
• Crear usuarios.
• Asignar usuarios a empresas.

Una empresa puede tener varios usuarios, pero un usuario solo pertenece a una empresa.

Crear la automatización

Vaya a OpenKM Administración > Automatización y registre una automatización para catalogar documentos.

Debe crear 5 automatizaciones en modo post:

Crear automatización	Definición de la automatización
Vaya a la administración de OpenKM, seleccione la opción Automatización y Nueva regla, rellene el nombre “Invoice catalog standard add”, seleccione el evento “Add metadata group”, y marque la casilla “Activo”.	- Añadir validación: seleccione la opción PathContains, actívela, y seleccione la carpeta “standard.import.node” definida en las propiedades de invoice-capture. - Añadir acción: seleccione la opción InvoiceCatalog y actívela.
Vaya a la administración de OpenKM, seleccione la opción Automatización y Nueva regla, rellene el nombre “Invoice catalog advanced add”, seleccione el evento “Add metadata group”, y marque la casilla “Activo”.	- Añadir validación: seleccione la opción PathContains, actívela, y seleccione la carpeta “advanced.import.node” definida en las propiedades de invoice-capture. - Añadir acción: seleccione la opción InvoiceCatalog y actívela.
Vaya a la administración de OpenKM, seleccione la opción Automatización y Nueva regla, rellene el nombre “Invoice catalog standard set”, seleccione el evento “Set metadata group”, marque la casilla “Activo” y seleccione Post.	- Añadir validación: seleccione la opción PathContains, actívela, y seleccione la carpeta “standard.import.node” definida en las propiedades de invoice-capture. - Añadir acción: seleccione la opción InvoiceCatalog y actívela.
Vaya a la administración de OpenKM, seleccione la opción Automatización y Nueva regla, rellene el nombre “Invoice catalog advanced set”, seleccione el evento “Set metadata group”, y marque la casilla “Activo”.	- Añadir validación: seleccione la opción PathContains, actívela, y seleccione la carpeta “advanced.import.node” definida en las propiedades de invoice-capture. - Añadir acción: seleccione la opción InvoiceCatalog y actívela.
Vaya a la administración de OpenKM, seleccione la opción Automatización y Nueva regla, rellene el nombre “Invoice upload”, seleccione el evento “Document create”, y marque la casilla “Activo”.	- Añadir validación: seleccione la opción PathContains, actívela, y seleccione la carpeta “standard.import.node” definida en las propiedades de invoice-capture. - Añadir acción: seleccione la opción InvoiceUpload y actívela.

Nota

En el fichero invoice-capture.properties (en la carpeta de Tomcat) se definen los UUIDs de ambas carpetas creadas en OpenKM:

standard.import.node = bb381ac2-f3f6-42b4-8df6-fbd0e87054ce
advanced.import.node = 76d1c3c7-d085-47ec-a153-c146e63ee9d9

Precaución

El valor del UUID de los nodos depende de su instancia de OpenKM.

Registrar los metadatos

Vaya a OpenKM Administración > Metadatos y registre la siguiente definición de metadatos

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.9//EN"
    "http://www.openkm.com/dtd/property-groups-3.9.dtd">
<property-groups>

<property-group label="Document type" name="okg:invoice_doc_type">
    <select label="Type" name="okp:invoice_doc_type.type" type="simple" optionsQuery="select DTP_METADATA_GROUP, DTP_TYPE from INV_DOCUMENT_TYPE order by DTP_TYPE desc"/>
</property-group>

</property-groups>

Modo estándar

Nota

Un usuario trabaja en modo estándar cuando es miembro de ROLE_STANDARD.

Un usuario con este rol está asignado a una empresa, y solo puede catalogar facturas de esa empresa.

En modo estándar, los usuarios pueden catalogar facturas y buscar facturas por su empresa asignada, tipo de documento, año y mes.

Catalogar facturas con metadatos

1. Haga clic en la opción STEP 1 situada en el menú superior izquierdo

2. Añada facturas desde su disco local haciendo clic en el botón Add files, y súbalas haciendo clic en el botón Upload de cada una (o en el botón Upload all).

3. Una vez subidas las facturas, haga clic en la opción STEP 2 del menú superior izquierdo.

4. Establezca los metadatos de la factura para cada factura subida en el paso anterior. Para confirmar los cambios, haga clic en el botón Add. Este botón se activará cuando el formulario esté completo.

Precaución

En el formulario de metadatos, el campo Company name es la empresa asignada a este usuario.

Buscar facturas

1. Haga clic en la opción SEARCH del menú superior derecho.

2. Rellene los campos de año y mes, y haga clic en el botón Search.

3. Se mostrará un listado de facturas filtrado por las empresas del usuario, tipo de documento, año y mes.

Nota

Se muestra una fila en una tabla con los campos Type, Name, Size, Author, Date, Tax number, VAT, y Total para cada factura.

En cada fila puede ver un botón Download para descargar la factura.

Modo avanzado

Nota

Un usuario trabaja en modo avanzado cuando es miembro de ROLE_ADVANCED.

Un usuario con este rol puede catalogar facturas de la empresa que tenga asignada.

En modo avanzado, los usuarios pueden catalogar facturas y buscar facturas por empresas (proveedores), tipo de documento, año y mes.

Catalogar facturas con metadatos

Igual que se explica arriba para el modo estándar.

Precaución

En el formulario de metadatos, el campo Company name es una lista de empresas creadas por un usuario administrador.

Buscar facturas

Igual que se explica arriba para el modo estándar.

Modo administrador

Nota

Un usuario trabaja en modo administrador cuando es miembro de ROLE_ADMIN.

Por defecto, la aplicación incluye un usuario administrador llamado admin.

En modo administrador, los usuarios pueden catalogar facturas, gestionar empresas, gestionar usuarios, y buscar facturas por año y mes.

Gestión de empresas

1. Haga clic en la opción COMPANY del menú superior derecho.

2. Rellene los campos obligatorios: Tax number y Name, y opcionalmente Internal code, para crear una nueva empresa, y finalmente haga clic en el botón Add.

3. En el listado de empresas, puede editarlas o eliminarlas haciendo clic en el botón Edit o Delete respectivamente.

Gestión de usuarios

1. Haga clic en la opción USERS del menú superior derecho.

2. Rellene los campos obligatorios: Id, Password, y Name; asigne un role, y opcionalmente asigne una empresa para crear un nuevo usuario; finalmente haga clic en el botón Add.

3. En el listado de usuarios, puede editarlos o eliminarlos haciendo clic en el botón Edit o Delete respectivamente.