Installation

Steps to install and configure the Invoice Capture application in OpenKM v7.1:

In case you want to install Invoice Capture on a different server than OpenKM, you need to create the database:

CREATE USER 'invoice'@'%' IDENTIFIED BY 'openkm';
CREATE DATABASE invoice DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_bin;
GRANT ALL ON invoice.* TO 'invoice'@'%' WITH GRANT OPTION;

Otherwise you have to use the same database used by OpenKM.

Register the English and Spanish translations in OpenKM.
Stop Tomcat
Download the application from the OpenKM download center
Place the invoice.war file into $TOMCAT_HOME/webapps
Place the invoice-plugins.jar file into $TOMCAT_HOME/plugins
This application needs to share the database with OpenKM, so you don’t need to create a new one.
Create the configuration file $TOMCAT_HOME/invoice-capture.properties (this is a sample configuration which needs to be adapted to the target environment)

# Database
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/okmdb?useUnicode=true&characterEncoding=UTF8&serverTimezone=CET
spring.datasource.username=openkm
spring.datasource.password=openkm
spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL57InnoDBDialect

# OpenKM
openkm.url=http://localhost:8080/openkm
openkm.url.preview=http://server.ip:8080/openkm

# OpenKM admin user
admin.user=invoice
admin.password=s3cr3t0

# Preview
preview.download.url=http://server.ip:8080/invoice/download

# OpenKM folder
standard.import.node=bb381ac2-f3f6-42b4-8df6-fbd0e87054ce
advanced.import.node=76d1c3c7-d085-47ec-a153-c146e63ee9d9
root.destination.folder.path=/okm:root/invoice

# Available languages
languages=en-GB,es-ES
default.language=es-ES

# Logos
app.logo=http://server.ip:8080/openkm/logo/login
app.logo.login=http://server.ip:8080/openkm/logo/login

# Filter companies list in the search view based in documents of the companies previously uploaded by the user
filter.companies.by.user.upload.documents=false

The openkm.url configuration property family is also important because Invoice Capture will use this user to interact with your OpenKM instance. So, configure a user with enough permissions. This user should already exist in OpenKM.

The standard.import.node and advanced.import.node properties need to be valid UUIDs of existing folders in your OpenKM. These folders are used to upload the invoice documents.

The folder defined in root.destination.folder is created automatically in the root of your OpenKM taxonomy when the first invoice is catalogued.

Start Tomcat
Edit the configuration file $TOMCAT_HOME/invoice-capture.properties and modify the value of this property to “update”; this property should look like this:

spring.jpa.hibernate.ddl-auto=update

Log into OpenKM and follow the user guide for Invoice Capture.

Once the application is configured you can log to http://server.ip:8080/invoice with the default administrator:
- User: admin
- Password: admin
Remember to change this default password!