Web Scanner Installation Guide
Introduction
This document provides installation guidelines for the Ephesoft Transact Web Scanner. Four methods of installation are available:
Installation from the Ephesoft Transact user interface
Installation from the Ephesoft Transact directory
Manual installation (for non-administrators)
Silent installation
Prerequisites
The following prerequisites are required to…
Ephesoft Cloud HyperExtender Plugin 2020.1
Available: Cloud
Introduction
This document outlines the setup and configuration for the Ephesoft Cloud HyperExtender (CHE) plugin in Ephesoft Transact. CHE accommodates spikes in batch class volume by offloading document splitting and optical character recognition (OCR) to the Ephesoft Cloud.
Global CHE service is centrally hosted in the following four locations. For best performance,…
Windows Upgrade Guide 2020.1
Introduction
This document describes how to upgrade to Ephesoft Transact 2020.1 in the following environments:
Environment types — single and multi-server
Operating System — Windows®
Important: Steps unique to a multi-server upgrade are identified where applicable in this document.
Upgrade Overview
The process of upgrading to Ephesoft Transact 2020.1 follows this general sequence…
Linux Installation Guide 2020.1
Introduction
This document describes how to install Ephesoft Transact 2020.1 in the following environments:
Environment types — single or multi-server
Operating System — Red Hat Enterprise Linux (RHEL) 7.5 or 7.6
Note: Ephesoft Transact 2020.1 is only supported for these Linux distributions. Do not run the sudo yum update command, as this updates RHEL to an unsupported version. Refer…
Windows Installation Guide 2020.1
Introduction
This document describes how to install Ephesoft Transact 2020.1 in the following environments:
Environment types — single and multi-server
Operating System — Windows®
Installation types — normal and silent
Important: Steps unique to a multi-server installation are identified where applicable in this document.
Installation Overview
The process of installing Ephesoft…
Ephesoft Transact Reporting and Workflow
Introduction
Reporting consists of the following major functions:
Data Migration
Data Calculation
Data Cleanup
Ephesoft Transact Reporting also supports multiple languages as part of the User Interface. For more information, refer to Global Languages.
Note: This document applies to Ephesoft Transact 2019.1 and above.
Reporting Process – Cron Jobs
A single master cron job…
KB00007089: Pre-request Information is Required in the Postman Application for the Ephesoft UploadBatch Web API
Issue:
Pre-request information is required in the Postman application for the Ephesoft UploadBatch web API.
Solution:
Open the Postman application.
In the POST field, enter a URL in the following format: http://<serverName/IP address>:<port>/dcma/rest/uploadBatch/<batchClassIdentifier>/<batchInstanceName>
Figure 1 below uses the following URL as an…
Linux Silent Install 2019.1
Overview
This document provides information on how to install Ephesoft Transact 2019.1 in the following environment:
Environment — single-server
Operating System — Linux
Installation type — fresh silent
The silent-mode installation allows the user to define installation configuration only once and then use it to duplicate the installation on many machines. The config.properties…
Ephesoft Transact 2019.1 Upgrade Guide – Single-Server – for Linux
Overview
This document provides information on how to install Ephesoft Transact 2019.1 in the following environment:
Environment — single-server
Operating system — Linux
Installation type — upgrade
The following tasks describe how to upgrade to Ephesoft Transact 2019.1:
#
Installation Task
General Scope of Activity
1
Complete the Prerequisites Check
Prepare for…
Linux Fresh Normal Install 2019.1
Overview
This document provides information on how to install Ephesoft Transact 2019.1 in the following environment:
Environment — single-server
Operating System — Linux
Installation type — fresh normal
The following tasks describe how to install Ephesoft Transact 2019.1 for Linux:
#
Installation Task
General Scope of Activity
1
Complete the Prerequisites Check…
Install and Migrate to MariaDB for Windows
Introduction
This document provides information on important changes related to MariaDB and MySQL on Windows. The following changes affect Ephesoft Transact 2019.2 or above:
The Ephesoft Transact installer no longer installs any database management systems (DBMS).
Ephesoft Transact no longer supports MySQL databases.
Refer to Install and Upgrade and reference the Platform…
Install Ephesoft Transact 2019.2 – Single and Multi-Server
Introduction
This document describes how to install Ephesoft Transact 2019.2 in the following environments:
Environment types — single and multi-server
Operating System — Windows®
Installation Overview
The process of installing Ephesoft Transact 2019.2 follows this general sequence of tasks.
Installation Task
General Scope of Activity
Prerequisites
Prepare for…
Ephesoft Transact 2019.1 Service Pack
Summary
This Service Pack for Ephesoft Transact 2019.1 addresses a number of issues identified after the launch of Ephesoft Transact 2019.1 on January 31st, 2019. This is a MANDATORY Service Pack install. It must be applied to ensure that Ephesoft Transact functions properly.
This Service Pack addresses five specific issues:
Batch Class Edits — Edits to the batch class are not saved…
Ephesoft Cloud HyperExtender Plugin 2019.1
For newer versions of this plugin, refer to:
Ephesoft Cloud HyperExtender Plugin 2020.1
Ephesoft Cloud HyperExtender Plugin 2019.2
Introduction
This document describes how to configure the Ephesoft Cloud HyperExtender plugin for Ephesoft Transact.
The Ephesoft Cloud HyperExtender plugin addresses the heaviest processing needs of the Transact workflow by offloading document…
Ephesoft Cloud HyperExtender Plugin 2019.2
Available: on-premises, cloud
Introduction
This document describes how to configure the Ephesoft Cloud HyperExtender plugin for Ephesoft Transact, how to register for an Ephesoft Cloud account that is specific to the Ephesoft Cloud HyperExtender, and how to configure Ephesoft Transact to connect to that Ephesoft Cloud account.
The plugin addresses the heaviest processing needs of the…
Security Configuration
This section includes information about security configuration in Ephesoft Transact.
Password Masking
Security: Restricting access to certain Ephesoft Web Pages
Ephesoft Encryption Framework – Continued
How to: Configure Batch Class Encryption
Support for batches executed of Encrypted Batch Classes.
LDAP/AD Password Encryption
How to Encrypt Passwords in Ephesoft files…
Web Service Definitions and Code Samples
Overview
The Ephesoft Transact web services API provides a simple method for real-time integration and exposure of Ephesoft processes to external applications. This allows developers to embed and employ advanced capture capabilities and technologies in content management systems and other workflows.
Ephesoft Transact web services support the OpenAPI standard, and the Ephesoft Transact Web…
Integrating Ephesoft Transact with LDAP
This article provides the configuration steps to integrate Transact with LDAP.
In Ephesoft Transact, there are three properties files that you will need to configure:
server.xml
user-connectivity.properties
application.properties
What is required to configure Ephesoft Transact with LDAP?
In order to successfully integrate Ephesoft Transact with LDAP, it becomes essential to…
Integrating Ephesoft Transact with Active Directory
Integrating Ephesoft with Active Directory
This article explains how to integrate Ephesoft with Active Directory and provides detailed description for each property used in order to successfully configure Ephesoft with AD.
In Ephesoft Transact, we basically have to focus on 3 properties files mentioned below:
server.xml
user-connectivity.properties
application.properties……
Checklist: Ephesoft with ADFS over SAML 2.0 with Authentication Type 1 and Authorization using Active Directory
Ephesoft configuration with ADFS over SAML 2.0 with Authentication Type 1 and Authorization using Active Directory
This wiki provides you details related to what all configuration needs to be taken care of when configuring Ephesoft with ADFS over SAML 2.0 with Authentication Type 1. Authentication Type 1 means we are authenticating using SSO but authorizing using Tomcat, LDAP or Active…
Configuring Ephesoft Transact with ADFS over SAML 2.0 using Apache Tomcat
This article describes how to configure Ephesoft Transact with Active Directory Federation Services (ADFS) over SAML 2.0 using Authentication Type 1. Authentication Type 1 means we are authenticating using SSO but authorizing using Apache Tomcat, LDAP, or Active Directory. In this article, we will focus on authorization with Apache Tomcat using port 8443.
Overview
How does authentication with…
Checklist: Ephesoft with ADFS over SAML 2.0 with Authentication Type 2
Ephesoft configuration with ADFS over SAML 2.0 with Authentication Type 2
This wiki provides you details related to what all configuration needs to be taken care of when configuring Ephesoft with ADFS over SAML 2.0 with Authentication Type 2. Authentication Type 2 means we are authentication and authorizing using SSO.
Understanding Authentication Type 2
Integrating Ephesoft with…
Ephesoft Transact 4.5.0.2 Known Issues and Workarounds
Ephesoft Transact 4.5.0.2 Workarounds
#
Issue
Workaround
1
The following error occurs during upgrade from Ephesoft Transact 4.5.0.0-4.5.0.2 on Ubuntu 16.04:
“Error occurred while building dependency tree. Exiting from script...”
This error occurs when packages from repositories are not updated.
To update the packages from repositories, the following commands need to be…
Ephesoft Transact 2019.2 Known Issues & Workarounds
Category
Issue
Workaround
Installation and Upgrade:
Windows
After upgrading from Ephesoft Transact 2019.1 to version 2019.2 on a Windows system, the Windows Service account for Ephesoft Transact reverts back to the Local System account, and not to the Transact Windows Service.
The workaround for this issue is to run the Upgrade Wizard for Ephesoft Transact 2019.2,…
Manually Configuring SAML 2.0 SSO for Ephesoft Transact 4.5.0.x and 2019.1
SSO Overview
Single sign-on (SSO) is a mechanism of access control that can be applied on multiple related, but independent software systems. With this mechanism, a user logs in once and gains access to multiple systems without being prompted to log in again for each individual application. Conversely, single sign-off is a property mechanism whereby a single action of signing out terminates…