Class OCRDocumentPlugin

  • All Implemented Interfaces:
    org.imixs.workflow.Plugin

    public class OCRDocumentPlugin
    extends org.imixs.workflow.engine.plugins.AbstractPlugin
    The TikaPlugin extracts the textual information from document attachments. The plug-in sends each new attached document to an instance of an Apache Tika Server to get the file content.

    The TikaPlugin can be used instead of the TIKA_SERVICE_MODE = 'auto' which will react on the ProcessingEvent BEFORE_PROCESS. The plugin runs only in case the TIKA_SERVICE_MODE is NOT set to 'auto'!

    Version:
    1.0
    Author:
    rsoika
    See Also:
    OCRDocumentService
    • Field Summary

      • Fields inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

        INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void init​(org.imixs.workflow.WorkflowContext actx)  
      org.imixs.workflow.ItemCollection run​(org.imixs.workflow.ItemCollection document, org.imixs.workflow.ItemCollection event)
      This method sends the document content to the tika server and updates the DMS information.
      • Methods inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

        close, getCtx, getWorkflowService, mergeFieldList, uniqueList
    • Constructor Detail

      • OCRDocumentPlugin

        public OCRDocumentPlugin()
    • Method Detail

      • init

        public void init​(org.imixs.workflow.WorkflowContext actx)
                  throws org.imixs.workflow.exceptions.PluginException
        Specified by:
        init in interface org.imixs.workflow.Plugin
        Overrides:
        init in class org.imixs.workflow.engine.plugins.AbstractPlugin
        Throws:
        org.imixs.workflow.exceptions.PluginException
      • run

        public org.imixs.workflow.ItemCollection run​(org.imixs.workflow.ItemCollection document,
                                                     org.imixs.workflow.ItemCollection event)
                                              throws org.imixs.workflow.exceptions.PluginException
        This method sends the document content to the tika server and updates the DMS information.
        Throws:
        org.imixs.workflow.exceptions.PluginException