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…
Batch Instance Progress Bars
Overview
This feature allows a user to check the state of a batch instance. This feature shows the details of current state of a batch instance, the batch instance can be in any state. When a batch instance is selected from the batch instance grid, the details of the batch instance is displayed in the bottom panel. The bottom panel consists of two types of data regarding batch instance:…
Importing and Exporting Batch Classes
Overview
Ephesoft Transact supports transferring batch class configurations and rules from one environment to another. You can import and export batch classes to build and configure in a test environment before transferring to a production environment. This helps reduce interruptions that affect document processing in a production environment.
Refer to the table below for key terms used…
Key Value Page Process
Introduction
This document provides Transact administrators with steps to configure the KV Page Process plugin, which allows you to classify documents based on keywords, also known as keyword-based classification.
This feature improves document classification based on user-defined static and dynamic keywords in the document. The KV Page Process plugin can be tailored to the specific needs of…
Batch.xml and XSD Schema for Developers
Introduction
This reference document provides information for developers who want to add additional functionality or customize their solution beyond a regular installation of Ephesoft Transact. This document applies to Ephesoft Transact 2019.1 and above.
Developer tasks could entail web services, scripting, interoperation between Ephesoft Transact and external applications, or other custom…
CMIS Import
Overview
You can automatically download files from a CMIS-compliant repository and process them as batches in Ephesoft Transact using the CMIS Import feature.
CMIS-compliant repositories include, but are not limited to:
Alfresco
Nuxeo
Documentum
SharePoint
The CMIS Import monitors the CMIS-compliant repository using a cron job, which periodically checks a specified folder for…
How to Configure Chinese language Support at the Database Level
Applicable Ephesoft Transact Versions: 4.x or above
This article provides steps on how to configure the key-value pair for KV extraction in the Chinese language at the database level.
For MySQL/MariaDB:
To insert Chinese characters in the key_pattern and value_pattern columns of the kv_extraction table, change the collation of these columns from latin1_swedish_ci to utf8_bin by…
Application.properties
Filename: application.properties
Location: C:\Ephesoft\Application\WEB-INF\classes\META-INF\
Purpose: Configures…
ephesoft.product.version=3.1.2.9
report.ant.buildfile.path=C:\\Ephesoft\\Report/ephesoft-reporting/build.xml
enable.reporting=true
enable.uploadBatch=true
#default doc type view can be "dropdown_list" or "suggest_box"
document.default_doc_type_view=suggest_box_view…
Migrating a Batch Class from Windows to Linux
Applies to: All versions of Ephesoft Transact
This article provides steps on how to take a batch class created for Transact on a Windows server and import it to a Transact instance installed on a Linux server.
User Steps
There are a few things that must be changed after you import a Batch Class into an Ephesoft Transact instance installed on a Linux server if the Batch Class was exported…
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…
Add New Index Field
In this page, you will learn what an index field is, and how to create a new index field in Ephesoft Transact.
What is an Index Field?
Prerequisites
Add New Index Field
Import Index Field
Next Steps
What is an Index Field?
An index field is used to store metadata for fields in a particular document. These fields can then be used to classify documents or extract data from the…
Add New Document Type
In this page, you will learn what a document type is, and how to create a new document type in Ephesoft Transact.
What is a Document Type?
Prerequisites
Add New Document Type
Import Document Type
Next Steps
What is a Document Type?
As the name suggests, a document type is a kind of document which belongs to a specific category. Here are some examples of document types:…
Ephesoft Linux Multi-Server Upgrade Installation Guide
Prerequisites
Following configuration is required for installing Ephesoft on Linux machine using command line Single script Linux installer:
RedHat 6.5 or Ubuntu 13.10 OS (Installer is specifically built and tested on RedHat v 6.5 and Ubuntu v 13.10).
Internet connection is required as some software need to be updated or installed from OS’s repository during Ephesoft’s installation.…
Ephesoft Linux Multi-Server Upgrade Installation Guide
Prerequisites
Following configuration is required for installing Ephesoft on Linux machine using command line Single script Linux installer:
RedHat 6.5 or Ubuntu 13.10 OS (Installer is specifically built and tested on RedHat v 6.5 and Ubuntu v 13.10).
Internet connection is required as some software need to be updated or installed from OS’s repository during Ephesoft’s installation.…
Ephesoft Transact Linux Multi-Server Installation Guide
Prerequisites
Following configuration is required for installing Ephesoft Transact on Linux machine using command line Single script Linux installer:
RedHat 6.8 or Ubuntu 13.10 OS (Installer is specifically built and tested on RedHat v 6.8 and Ubuntu v 13.10).
Make sure that sudo apt-get update and sudo apt-get upgrade have been run before running the installer.
Internet connection is…
Ephesoft Linux Multi-Server Installation guide
Prerequisites
Following configuration is required for installing Ephesoft on Linux machine using command line Single script Linux installer:
RedHat 6.8 or Ubuntu 13.10 OS (Installer is specifically built and tested on RedHat v 6.8 and Ubuntu v 13.10).
Make sure that sudo apt-get update and sudo apt-get upgrade have been run before running the installer.
Internet connection is required…
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…
IBM CM Plugin
Available: on-premises, cloud
Overview
This plugin is used to export batch XML in IBM content management schema format. Basically this plugin transforms batch xml to another XML acceptable by IBM Content Management.
Configuration
Steps for configuring the plugin
User can select the Export module and navigate to IBM CM plugin configuration page as shown below:
Users can edit the…
Docushare Export Plugin
Available: on-premises, cloud
Overview
This plug-in is used for exporting zipped file for a batch. It transforms the batch xml to another xml format acceptable by Docushare CMS and zips it along with multipage pdf to Docushare export folder location.
Steps of execution
This plug-in works in the export phase of the application when all the processing on the batch has been done and…
CSV File Creation Plugin
Available: on-premises, cloud
Overview
This plugin is used for exporting the CSV file for a batch. It transforms the batch.xml file to a CSV file format acceptable and exports it to the final CSV export folder location configured in the “CSV Creation Final Export Folder” property. The CSV file is created using the batch.xml file for the document level fields present. If the switch is ON then a…
4.0 Plugins documentation
Automated Regex Validation
Barcode Extraction
Barcode Reader Plugin
Clean Up Plugin
CMIS Export Plugin
Copy Batch XML
Create Display Image Plugin
Create Multipage Files Plugin
Create OCR input Plugin
Create Thumbnails Plugin
CSV File Creation Plugin
DB Export Plugin
Document Assembler Plugin
Docushare Export Plugin
Fuzzy DB Extraction Plugin
IBM CM…
Supported Languages
This article outlines languages supported when using Ephesoft Transact and optical character recognition (OCR) engines.
UI Supported Languages
The Ephesoft Transact user interface can be displayed in the following languages:
Dutch
English
French
German
Italian
Spanish
Document Processing
Ephesoft Transact supports classification and extraction for documents containing…
Supported File Types for Import
The following file types are supported in the Upload Batch screen, drop folder, uploadBatch web service, and email attachment import methods in Ephesoft Transact:
TIF
TIFF
PDF
BMP
DOC
DOCX
HTM
HTML
JPEG
JPG
ODF
ODG
ODP
ODS
ODT
PNG
PPT
PPTX
PSD
RTF
SXC
SXD
SXI
SXW
TXT
WPD
XLS
XLSX
ZIP
TIF, TIFF, and PDF…
RecoStar HOCR Plugin
Available: on-premises, cloud
Overview
The RecoStar HOCR plugin is a part of the Page Process module, by default. The following snapshot illustrates the plugins that are typical for the Page Process module:
RECOSTAR_HOCR plugin in the Page Process module
This plugin uses the RecoStar OCR (optical character recognition) engine for generating HOCR XML files. This plugin reads the image…
Regular Expressions
Introduction
This document provides information about the regular expression patterns used by the extraction module of Ephesoft.
Overview
Regular expressions are a way to describe a set of strings based on common characteristics shared by each string in the set. They can be used to search, edit or manipulate text and data. Below is a table of basic regular expression constructs. The…