REST API Lookup Plugin

Skip to: Introduction Prerequisites Configuration of REST API Lookup using the Web Service URL Configuration of REST API Lookup using the custom JAR file REST API Lookup on the Validation screen Configuration of XPath/JSONPath Introduction Ephesoft Transact 4.5.0.0 now supports REST API Lookup. It is used to extract the document level fields of a document on basis of the…

Custom Plugins

This space includes resources for developers looking to create and manage custom plugins. Custom plugins can be used to alter the default workflow of Ephesoft Transact to meet a specific use case. They can be Ephesoft-developed or user-developed, but they are maintained by the user. Important: Before proceeding, read and agree to the Developer Disclaimer. This space includes the following…

KB0171512 Long running batches and duplicate RecostarPlugin processes

KB Articles   KB Article # 171512 Topic/Category: Activiti, 4x Issue: Duplicate processes result in error similar to: 2017-05-22 12:03:06,014 - Uncaught Exception in readOCR method Batch Instance with identifier BI2B3DE is either deleted or restarted midway of processing com.ephesoft.dcma.core.exception.BatchInstanceDeletionOrRestartException: Batch Instance with…

Regular Regex Extraction Plugin

Available: on-premises, cloud Overview This plugin extracts index field values based on the pattern defined for that field.  A semicolon-separated collection of one or more words followed by a regular expression can be defined for the pattern.  The system will search each page for the regular expression.  If a match is found, the system will look to the left of the match and see if all of the…

Advanced Barcode Extraction Plugin

In this document, you will learn how to configure and perform advanced barcode extraction in Ephesoft Transact. Use Cases Advanced barcode extraction is useful when: You are extracting data from documents with multiple barcodes on a single page. You are extracting data from documents with both 1D and 2D barcodes. You are looking for an alternative to RecoStar Fixed Form barcode…

Microsoft SharePoint 365 Export Plugin

Available: on-premises, cloud The "SHAREPOINT_365_EXPORT" plugin exports documents to an online SharePoint repository. User can configure the export for each Document Type and connection settings in both online and offline mode. But for exporting the documents, connection with the SharePoint account is required. The PDF and TIFF files are exported to the online SharePoint repository along with…

Creating Custom Plugins

Prerequisites Important: Before proceeding, read and agree to the Developer Disclaimer. To create a custom plugin for Ephesoft Transact, you will need the following installed on your system: Java JDK Apache Maven Eclipse Maven To install Maven, perform the following steps: Open Eclipse. Go to Help > Eclipse Marketplace. Search “Maven”. Click Install on “Maven…

Import Multipage Files Plugin

Available: on-premises, cloud Overview Import Multipage Files plugin is required when running a batch on multipage images. This plugin will break the multipage pdf’s and tiffs into multiple single page tiffs. Multipage pdf’s will be converted to single page tiffs using Ghostscript/Recostar whereas multipage tiffs will be converted to page single page tiffs using ImageMagick/GraphicMagick .……

Default Index Field Value Plugin

Available: on-premises, cloud Note: This plugin is only available within the Transact UI. There is no API call available for this functionality. Overview Default Index Field Value Plugin will be responsible for providing a default value to the document level index field. Admin can configure this default value either by providing some default value or via batch field values which is provided…

Create OCR Input Plugin

Available: on-premises, cloud Overview This plugin is used for generating PNG files corresponding to input files. These input files may be tiff files or multipage tiff files. These PNG files are used for further processing and OCRing. It uses ImageMagick/GraphicMagick for converting files to PNG which will be used for OCRing. Configuration You can select the Page Process module and navigate…

Create Multipage Files Plugin

Available: on-premises, cloud This page describes how to configure the Create Multipage Files plugin in Ephesoft Transact. These steps are intended for Transact administrators. Overview The Create Multipage Files plugin is a default plugin in the Export module. This plugin generates multipage PDF and TIF files for each document type of a batch inside the final drop folder. This final drop…

Create Display Image Plugin

Available: on-premises, cloud Overview This plugin creates display images to be used both for thumbnail display and comparison purposes. Configuration Steps for configuring the plugin Navigate to the Page Process module and select the CREATE_DISPLAY_IMAGE plugin as shown below.  Neither property is editable, as other plugins depend on these files. Configurable Properties This plugin…

Nuance HOCR Plugin

Available: on-premises, cloud Assumptions: 1. Since the image enhancements like deskew, etc. is being done in Page Process module in case of Recostar, therefore image enhancement is done in Page Process module only in case of Nuance as well. 2. Despeckling is done by default in pre-processing of image by Nuance. Despeckling means detecting and removing halftone or dithering type noises.…

Key-Value Extraction Plugin

Available: on-premises, cloud Introduction In this document, you will learn how to configure and perform key-value (KV) extraction in Ephesoft Transact. With key-value extraction, Ephesoft Transact will search for user-defined keys that are static text on forms and then identify the associated values that are considered the dynamic portions of the document. This process varies based on the…

CMIS Export Plugin

Available: on-premises, cloud The CMIS Export plugin is used to upload the final output of batch execution (PDF or TIFF files) to a CMIS-compliant repository as a “Document” object. Ephesoft Transact supports most CMIS-compliant repositories, including the following: Alfresco Nuxeo SharePoint IBM CM Documentum To upload documents and associated properties on the…

Table Extraction Plugin

Available: on-premises, cloud Overview The Table Extraction plugin is responsible for extracting data from the batch with tabular data in the form of tables. The user defines basic table information and a set of table columns for the table. Ephesoft Transact uses one or more rules to perform table extraction. Note the following factors for table extraction: There may be multiple table…

Modules and Plugins

Ephesoft Transact uses a combination of automatic and manual modules which allows you to create a customized workflow to meet your business needs. Modules and their respective plugins are customized on the batch class level. Transact includes the following modules (in their recommended order): Folder Import Page Process Document Assembly Review Document Extraction Automated…

DB Export Plugin

Available: on-premises, cloud Introduction In this document, you will learn how to configure the DB Export plugin in Ephesoft Transact. The DB Export plugin is responsible for saving the data of the document level fields for a particular batch instance to an external database. It uses a provided mapping file to create a SQL query to insert the mapped document level field into the mapped…

Tesseract HOCR Plugin

Available: on-premises, cloud Overview The TESSERACT_HOCR plugin is commonly used in the Page Processing module. This plugin reads the image files listed in the batch.xml file for a batch, generates an HOCR.xml file for each image, and updates the batch.xml accordingly. Configuration Following are the list of configurable properties for TESSERACT_HOCR plugin from the UI:…

Tabbed PDF Plugin

Available: on-premises, cloud This plugin is used to merge all multi-page PDFs to form a single-tabbed PDF file based on a placeholder. This plugin creates bookmarked PDF files in the configured export folder by merging all multi-page PDFs. Configuration Steps for configuring the plugin Select the Export module and navigate to TABBED_PDF plugin configuration page as shown below: You…

Search Classification Plugin

Available: on-premises, cloud Introduction This document describes how to configure and use the Search Classification plugin. The plugin classifies documents in the Page Process module of the workflow using Lucene-based indexing. Classification is how Ephesoft Transact chooses or associates the document to the Document Type. This document applies to Ephesoft Transact 2019.1 and above.…

Scripting Plugin

Available: on-premises, cloud Overview This plug-in reads the batch’s batch.xml file and works upon the given document as per the scripts given in the scripts folder. All the scripts are placed inside “{SharedFolder}batch class folder (ex:-BC1)scripts”. For any script there are two ways to write it, either it could be written in “IScript” or “JDOM”. For running any type of script user needs…

Nuance Extraction plugin

Available: on-premises, cloud The Nuance extraction plugin is part of the extraction module. This plugin extracts the data for the document level fields (DLF) for the particular document classified by the document assembler plugin. This plugin uses a .zon (zone) file to extract data for the specific document level field. You will need to create the zone file using the Nuance Form Template…

Key Value Learning Plugin

Available: on-premises, cloud Overview Update 2021: This plugin has since been replaced by the Auto KV plugin. You can find this plugin in Ephesoft Labs. This plugin is used to generate Advanced KV pairs to make the data extraction more appropriate based on past data extracted by the user manually. It keeps track of the data which is extracted manually by the user by populating DLFs directly…

Import Batch Folder Plugin

Available: on-premises, cloud The IMPORT_BATCH_FOLDER plugin copies the batch files from the UNC folder to the Ephesoft system folder. This plugin creates a folder in the Ephesoft system folder with the name of the batch instance folder, and copies the batch files to this folder. Files with valid extensions will be moved from the UNC folder. Configuration Properties File Properties…