Setup a Disaster Recovery Server
This page presents important points to address when planning disaster recovery.
Prerequisites
You have a separate Ephesoft Installation
You've taken a backup of SharedFolders
You have high availability with replication options over the database server
You have a separate DR license with a limited image count
Database Setup
A database should have high availability, which can be…
Change Ephesoft Transact from root to non-root
Topic #1 : How to change Ephesoft Transact to run as non-root when it was installed to run under the root user.
Applicable Ephesoft versions: 4.1.2.0 or Higher
These instructions will help you configure Ephesoft to run as a non-root user. For the example below, we are using the ephesoft user which we have already created and given sudo rights. Sudo rights are required for the user under…
Form Data Extraction Using Nuance
This page describes how to install, activate, and configure Fixed Form Extraction using Nuance. To integrate with Nuance, you will need to use the Nuance Extraction plugin. These instructions are intended for Transact administrators.
Overview
The NUANCE_EXTRACTION_PLUGIN is part of the Extraction module. You can use the NUANCE_EXTRACTION_PLUGIN to extract:
Text data
Checkbox data
OCR…
4.5.0.0
Please see the latest release notes for Ephesoft Transact 4.5.0.0:
Latest
Ephesoft Transact 4.5.0.2
Ephesoft Transact 4.5.0.1
Ephesoft Transact 4.5.0.0
To obtain the Windows or Linux installer for Ephesoft Transact 4.5.0.0, visit the Customer Support Portal. Contact Ephesoft Support for credentials.
Previous Releases
Ephesoft Transact 4.1.3.0
Ephesoft…
2019.1
Ephesoft Transact Version 2019.1
Introduction
This document introduces Ephesoft Transact v.2019.1, contains short descriptions of new features and enhancements to the Ephesoft Transact product, and cites specific bug fixes and workarounds for potential issues.
Starting with Ephesoft Transact release 2019.1, the product versioning has changed, as follows
Instead of major and minor…
2019.2
Introduction
This document introduces Ephesoft Transact 2019.2 and contains a short description of new features and enhancements to the Ephesoft Transact product as well as specific bug fixes and workarounds for potential issues.
Installation and Licensing
Licensing
If you are upgrading to Ephesoft Transact 2019.2 from a previous release, you may be required to obtain a new license file for…
KB0010063: Manually Cleaning the Activiti Tables
Applies to: Ephesoft Transact 4.5.0.0 and above
Issue
A significant amount of workflow data can accumulate over time, which may hamper the overall application performance.
Solution
You can avoid this issue by manually cleaning up the Activiti-related tables using the instructions in this article, but this manual cleanup method is only recommended for extenuating circumstances.
Important:…
Transact Windows Uninstallation Guide
Applies to: All versions of Ephesoft Transact
Prerequisites
Ephesoft Transact is installed on the system.
If desired, follow these steps to perform a backup of the Ephesoft system database.
In a multi-server installation scenario, unmount SharedFolders before proceeding with uninstallation.
Uninstallation Steps
Perform the following steps to uninstall Ephesoft Transact:…
Pickup Service
Introduction
This page provides an overview of the pickup service feature and its recommended settings in Ephesoft Transact.
Overview
Pickup service refers to the automatic services that feed the Activiti framework to execute a batch. The workflow for this feature varies by version:
2020.1.02 and below
New documents are uploaded into the system and converted to batch instances.
Batch…
How To Use Jvisualvm
Introduction to Java VisualVM
Java VisualVM is a tool that provides a visual interface for viewing detailed information about Java technology-based applications (Java applications) while they are running on a Java Virtual Machine (JVM). Java VisualVM organizes JVM data that is retrieved by the Java Development Kit (JDK) tools and presents the information in a way that enables you to quickly view…
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…
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…
System Configuration
Overview
This screen is enabled only for super-admin role. It contains following features:
1. Application
Regex Pool
Generate Key
Regex Builder
2. Workflow Management
It contain plugins and their respective dependencies needed by any workflow and criteria on which these plugins will be working.
3. Connection Manager
4. License Details
Below screenshot shows an…
Installing Ephesoft on Ubuntu 14.10
Question: Are there special steps necessary to install Ephesoft on Ubuntu 14.10?
Answer: Like Ubuntu 14.04, Ubuntu 14.10 is supported by Ephesoft with some minor steps to take before installing Ephesoft. Before attempting an install of Ephesoft on Ubuntu 14.10, the user must first install MySQL Server and change the root password for MySQL as this will be needed during the install…
How To Configure OpenLDAP
Topic: OpenLDAP Software is a free, open source implementation of the Lightweight Directory Access Protocol (LDAP) developed by the OpenLDAP Project. It is released under its own BSD-style license called the OpenLDAP Public License. LDAP is a platform-independent protocol.
To connect to the Ephesoft LDAP database and modify groups, users, permissions, etc administrators can utilize the bundled…
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…
RecoStar Extraction Plugin
Available: on-premises, cloud
Overview of the RECOSTAR_EXTRACTION Plugin
The RECOSTAR_EXTRACTION plugin is a part of the Extraction module, by default. This plugin extracts data from the fields that are contained in a document. The RECOSTAR_EXTRACTION plugin extracts data values from document-level fields in the Extraction module. This plugin is typically used for extracting data from fixed…
Troubleshooting Artifact Collection
Overview
The troubleshooting artifact download allows you to download or upload the selected artifacts. This feature creates a zipped file containing all selected artifacts and makes it available for download or upload.
The Troubleshoot section can be accessed by pressing the left arrow ( ◄ ) on the bottom right of the Batch Instance Management screen.
Figure 1: Batch Instance…
Multi-Server Deployment
Overview
This feature allows user to set up multi server environment for Ephesoft. By using multi server environment, two or more servers can run at the same time having shared database and shared folders.
This feature helps the user to increase the throughput via processing the batches using multiple servers.
Steps to setup Multi-Server environment for Ephesoft
User can install Ephesoft…
Upgrade Procedure: Windows
Upgrade Procedure:
1. Stop Ephesoft
2. Take a backup of the Ephesoft Installation Folder, SharedFolders and database.
3. Shutdown all Ephesoft related services and processes (e.g. soffice.bin)
4. Check that UAC is off and that the file is unblocked.
5. Run command prompt as administrator and run Ephesoft MSI Installer through following command.
msiexec.exe /i “<Path to Ephesoft…
How to Perform Routine Ephesoft Transact Backups
On a Daily Basis:
Create a backup of the Ephesoft Transact system database by executing command:mysqldump -uephesoft -pephesoft ephesoft2 > ephesoft_daily_12082011.sql
Note: In this example, the database is being saved to a file that reflects its status as a daily backup, and includes the date information (12/08/2011). For additional details, please review the Create a Full Database…
How to Administer Ephesoft Users and Groups
Ephesoft supports Tomcat, OpenLDAP and Microsoft Active Directory protocols for maintain a roster of users and groups. OpenLDAP is the default management system that is enabled and configured following a clean installation of Ephesoft Transact. There are two main configuration files:…