ASN QR Addon

This is an addon for Docspell to process ASN QR Codes

This project provides a simple cli tool to read these qr codes from images and pdf files. It can be installed as an docspell addon to process each file and add the extracted information as metadata to the document.

Usage

Use the latest released ZIP file to install this addon. It can be found here.

Create a new addon run configuration and add this addon to it having it run on final-process-item. This way the addon is run with every new file uploaded to Docspell.

Configuration

The addon does the following:

• detects QR codes on each file and tries to read them as [ASN QR-Code] qr codes
• if successful, the number can be attached to a custom field and tags can be added
• the data from the qr code is added to the item notes

You can optionally configure some steps using a YAML configuration. Here is an example:

add-tags:
  - ASN
  - QR-Code

check-tags:
  - ASN

The add-tags section is a list of tags (they must exist) that are added to the item when at least one QR code was found and decoded.

With check-tags you can tell the addon to only run when at least on of the defined tags are already present on an item. This can be useful if the tag classification works well and so you only apply this addon to documents classified as "Invoice", for example.

Each section is optional. You need to define add-tags if you want to add additional tags or set the amount to a custom field.

Example

Config

Outcome

Runner

The addon works with the trivial and docker runners. A docker image is build and published on each release, so there is no Dockerfile provided.

When using trivial, you need to have JDK 11+ installed (which is a prerequisite for Docspell itself, so it should be available already).