org.imixs.archive.documents

Class OCRDocumentService

java.lang.Object

org.imixs.archive.documents.OCRDocumentService

public class OCRDocumentService
extends Object

The TikaDocumentService extracts the textual information from document attachments. The CDI bean runs on the ProcessingEvent BEFORE_PROCESS. The service sends each new attached document to an instance of an Apache Tika Server to get the file content.

The service expects a valid Rest API end-point defined by the Environment Parameter 'TIKA_SERVICE_ENDPONT'. If the TIKA_SERVICE_ENDPONT is not set, then the service will be skipped.

The environment parameter 'TIKA_SERVICE_MODE' must be set to 'auto' to enable the service.

See also the project: https://github.com/imixs/imixs-docker/tree/master/tika

Version:

1.1

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCODING
static String	ENV_TIKA_OCR_MODE
static String	ENV_TIKA_SERVICE_ENDPOINT
static String	ENV_TIKA_SERVICE_MODE
static String	PLUGIN_ERROR

Constructor Summary

Constructors

Constructor and Description
OCRDocumentService()

Method Summary

Modifier and Type	Method and Description
void	onBeforeProcess(org.imixs.workflow.engine.ProcessingEvent processingEvent) React on the ProcessingEvent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

PLUGIN_ERROR

public static final String PLUGIN_ERROR

See Also:

Constant Field Values

ENV_TIKA_SERVICE_ENDPOINT

public static final String ENV_TIKA_SERVICE_ENDPOINT

See Also:

Constant Field Values

ENV_TIKA_SERVICE_MODE

public static final String ENV_TIKA_SERVICE_MODE

See Also:

Constant Field Values

ENV_TIKA_OCR_MODE

public static final String ENV_TIKA_OCR_MODE

See Also:

Constant Field Values

Constructor Detail

OCRDocumentService

public OCRDocumentService()

Method Detail

onBeforeProcess

public void onBeforeProcess(@Observes
                            org.imixs.workflow.engine.ProcessingEvent processingEvent)
                     throws org.imixs.workflow.exceptions.PluginException

React on the ProcessingEvent. This method sends the document content to the tika server and updates the DMS information.

Throws:

org.imixs.workflow.exceptions.PluginException