Plugin: CDSoftware DocuWare

Maintainer: Javier Galindo <[email protected]>
Sponsors: La Casa del Software
Status: Tested with release 12.0.0
License: GNU General Public License v2
Sources: CDSoftware DocuWare on La Casa del Software GitHub
Documentation: Repository README

Description

CDSoftware DocuWare is an iDempiere storage-provider integration for retrieving archived PDF documents from DocuWare. It registers archive and attachment storage services under the Docuware method.

The integration is under development. Archive retrieval is the only operational storage action in the current version; archive persistence and attachment operations remain placeholders.

Features

Registers a DocuWare archive provider through the standard iDempiere IArchiveStore service.
Authenticates against the DocuWare Platform API through Account/Logon.
Downloads a referenced PDF from a configured DocuWare file cabinet.
Registers an IAttachmentStore service for future attachment support.
Uses standard iDempiere Storage Provider configuration for the service URL, credentials and file cabinet identifier.

Storage services

Service	Ranking	Current behavior
Archive storage	100	Loads an archive using the DocuWare document identifier stored in its binary reference. Archive save, delete and flush are not implemented.
Attachment storage	10	The service is registered, but load, save, whole-attachment deletion and entry deletion are not implemented.

Requirements

iDempiere 12.
Java 17.
Access to a DocuWare Platform service.
DocuWare credentials authorized to log in and download documents from the required file cabinet.
An iDempiere Storage Provider record configured for the Docuware method.

Installation

Build and deploy the com.cdsoftware.docuware OSGi bundle for iDempiere 12.
Refresh the bundle or restart the iDempiere runtime.
Create or update an iDempiere Storage Provider record using the Docuware method.
Validate archive retrieval in a controlled environment before assigning the provider to operational records.

The repository does not contain an Application Dictionary 2Pack or an automated setup process. The Storage Provider record must be configured in iDempiere.

Configuration

Storage Provider field	DocuWare value
Method	`Docuware`
URL	DocuWare Platform base URL, including a trailing `/`
Username	DocuWare login user
Password	DocuWare login password
Folder	DocuWare file cabinet ID
Archive binary reference	DocuWare document ID used for archive retrieval

The plugin collects the authentication cookies returned by DocuWare and sends them with the document download request. If authentication fails or archive loading throws an exception, the archive provider returns the bytes already stored by iDempiere. A DocuWare download response without document data can return null.

Current implementation status

Archive retrieval is implemented.
Archive save, deletion and pending-flush handling are not implemented.
Attachment loading, saving and deletion are not implemented.
Upload, check-in, check-out and remote document lookup helpers remain placeholders.
The registered process, callout, event and form factories currently have no concrete plugin implementations to discover.

Documentation and source code