Plugin: CDSoftware Paperless

Maintainers: Javier Galindo <[email protected]>
Sponsors: La Casa del Software
Status: Tested with release 12.0.0
License: GPLv2
Sources: CDSoftware Paperless — GitHub of La Casa del Software
Documentation: Repository README

Description

CDSoftware Paperless integrates iDempiere attachment and archive storage with Paperless-ngx. Documents are uploaded to Paperless-ngx and retrieved when iDempiere loads the associated attachment or archive.

The plugin registers Paperless as an iDempiere storage method for both record attachments and archived documents. iDempiere retains the Paperless document references required to retrieve or delete the remote files.

Features

Paperless-ngx storage for iDempiere record attachments.
Paperless-ngx storage for iDempiere archived documents.
Upload, download, and remote deletion through the Paperless-ngx document API.
Multiple attachment entries stored through a filename-to-document-reference manifest.
Storage Provider configuration using the service URL, username, and password.
OSGi Declarative Services registration under the storage method Paperless.

Storage services

Service	iDempiere interface	Behavior
`AttachmentPaperless`	`IAttachmentStore`	Uploads attachment entries to Paperless-ngx and keeps their document references in an iDempiere ZIP manifest. When the attachment is loaded, each referenced document is downloaded and restored as an attachment entry. Supports deletion of an individual entry or the complete attachment.
`ArchivePaperless`	`IArchiveStore`	Uploads archive content to Paperless-ngx and stores the returned document reference in the archive data. Downloads the document when the archive is loaded and supports remote archive deletion.

Both services are registered with method Paperless and service ranking 100.

Requirements

iDempiere 12.
Java 17.
An accessible Paperless-ngx service with document API permissions.
An iDempiere Storage Provider record configured with the Paperless method, service URL, username, and password.

Installation

Deploy the com.cdsoftware.paperless OSGi bundle in iDempiere 12.
Refresh or restart the iDempiere runtime so the attachment and archive storage services are registered.
Open the iDempiere Storage Provider configuration and create or update a provider using method Paperless.
Assign the provider to the attachment or archive storage configuration where Paperless-ngx will be used.

The plugin does not include an Application Dictionary 2Pack. Its OSGI-INF XML files are OSGi service descriptors and are registered when the bundle starts.

Configuration and usage

Configure the Storage Provider URL with a trailing slash, for example https://paperless.example.com/.
Enter the Paperless-ngx username and password. The configured account must be able to upload, download, and delete documents through the API.
Save the Storage Provider and select it for the required attachment or archive storage configuration.
Upload a controlled attachment or generate a controlled archive from iDempiere.
Reload the iDempiere record and verify that the document is retrieved from Paperless-ngx.
Delete the controlled document from iDempiere and verify the corresponding result in Paperless-ngx before operational use.

The Storage Provider folder value is read by the integration but is not currently used to organize uploaded documents.

Documentation and source code