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…

Export to Web Service Plugin

Quick Reference Introduction Prerequisites Configure the Export to SOAP Web Service Configure the Export to REST Web Service Introduction This functionality allows the Transact users to export the batches (PDF/TIFF and Batch XML files) to the configured Web Service path. To implement this feature, a new EXPORT_TO_WEB_SERVICE plugin has been added to the Export module of Ephesoft…

KB0019641: How to Enable Web Service Calls with SSO in 2019.2 or Below

Applies to: Ephesoft Transact 2019.2 or below Issue: How to make Web Service calls when Ephesoft is configured with SSO Solution:  In 2019.2 and below, call to rest APIs works with basic authentication only and below steps needs to be followed for the same: Uncomment the security-constraint only for url-pattern /rest/* in web.xml. Uncomment the realm for LDAP/AD in…

Chromium Release 94+ (Chrome, Edge) Security Feature Introduces Incompatibility with Ephesoft Web Scanner Service

Applies to: Chromium version 94+ based browsers and Transact releases before 2022.1.00. Update 8/12/2022: Permanent fix is available by a hotfix or by upgrading to 2022.1 or newer. Hotfixes for older Transact versions will begin releasing 8/12/2022 onward. Please visit the Hotfix Library page on the Customer Support Portal to download available hotfixes. Update 7/29/2022: Beginning with…

Web Services Requests

Introduction This document outlines recommendations to prevent server overload and create request queues to limit the number of web services requests to the Ephesoft Transact server. Prerequisites Customers need to have a version of Ephesoft Transact with web services enabled. User Recommendations This section outlines recommendations to ensure optimal web services performance with Ephesoft…

Web Services Explorer (Swagger UI)

JTNDaWZyYW1lJTIwaGVpZ2h0JTNEJTIyNzAwJTIyJTIwd2lkdGglM0QlMjIxMDAlMjUlMjIlMjBzcmMlM0QlMjJodHRwcyUzQSUyRiUyRndlYi1zZXJ2aWNlcy1leHBsb3Jlci5lcGhlc29mdC5jbG91ZCUyRmRjbWElMkZyZXN0JTJGc3dhZ2dlci11aS5odG1sJTIyJTNFJTNDJTJGaWZyYW1lJTNF

Certificate error while using web scanner module – EphesoftTransactScannerService

Note: For an updated version of this document, refer to Expired Web Scanner Certificate. Topic/Category: Web scanner, Advanced Web scanner Issue : When browsing to the Advanced Web Scanner URL, the browser complains that site is not secure due to an expired certificate. Root cause: This issue occurs because the certificate has expired for ephesoft.inc.ca. This certificate is used by…

Transact Web Services API

Ephesoft Transact’s OpenAPI-Compliant web services provide a simple method for real-time integration and exposure of Ephesoft Transact capabilities to external applications, allowing developers to embed advanced capture features in their own solutions without having to display the Transact user interface. Ephesoft provides over 60 Transact web services to perform advanced capture actions in…

IIS: Incorrect Error Message being thrown from Web Services

Applies to: All versions of Ephesoft Transact Issue You may see the following error message with the copyDocumentType web API if a document type already exists: “The custom error module does not recognize this error”. This is different than the expected error message for this issue: “Name entered for new doctype already exists. Please enter a unique document name”. Root Cause  This error…

Expired Web Scanner Certificate

Applies to: All versions of Ephesoft Transact prior to 2020.1.05. Issue Beginning July 18, 2021, users may receive a message stating that the Ephesoft Transact Scanner Service is not running on the workstation when accessing Web Scanner from the Ephesoft Transact Operator menu. This message may appear even though the service is confirmed to be installed and running. This is not…

Issue with Ephesoft Transact Scanner Service and Chrome 85.0.4183.121

Applies to: All versions of Ephesoft Transact on Google Chrome 85.0.4183.121 Issue When accessing Ephesoft Transact on Google Chrome version 85.0.4183.121, you may receive the following error message when trying to use the Web Scanner module: “Ephesoft Transact Scanner Service is not running. Please run the service or install the Ephesoft Transact Scanner Service.” Figure 1. Web…

Web Scanner User Guide

Introduction This document provides user instructions for the Ephesoft Transact Web Scanner. The Web Scanner securely scans images into Ephesoft Transact from your client machine and supports both HTTP and HTTPS protocols. Images can be stored on the local system or on the server. Ephesoft Transact Web Scanner is certified to function with TWAIN-compliant scanners and their drivers.…

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 Transact 2019.2 Service Pack

Summary A service pack has been deployed on November 19, 2019, that affects Ephesoft Transact 2019.2. The service pack has been deployed to help correct issues discovered by our customers using Ephesoft Transact 2019.2. The service pack has been created to simplify deployment and correct these issues. The deployment of this service pack benefits customers by resolving the issues outlined…

Invalid Access Error Using Advanced Web Scanner

Applies to: Ephesoft Transact 4.5.0.0 to 2019.2 Resolved in: Ephesoft Transact 2019.2 Issue The following error occurs when attempting to use the Ephesoft Advanced Web Scanner, varying by version: Transact 4.5.x.x Figure 1. Error Message 4.5.0.0 Transact 2019.1 Figure 2. Error Message 2019.1 Transact 2019.2 Figure 3. Error Message 2019.2 Workaround If you see this error,…

Batch Instances Staying Locked when Web Scanner is OFF

Applies to: Ephesoft Transact 4.5.0.0 Resolved in: Ephesoft Transact 4.5.0.1 Issue If you have upgraded from an earlier version to Ephesoft Transact 4.5.0.0 and your Web Service License is turned off, you may see an issue with batch instances in which closing the browser tab does not unlock the batch instances. Workaround Manually unlock the stuck batch instances by clicking Unlock.…

Web Scanner Caching Improvement

In previous versions of Transact, in some cases display images stored in the temp folder of the Web Scanner Service installation directory were not deleted due to specific browser issues. In Ephesoft Transact v4.5.0.0, image caching for the Web Scanner Service has been improved. Browser caching for the Web scanner is now disabled. Specific meta-tags have been added in the HTML files for…

Advanced Web Scanner: ERROR: Batch Contains All Non-Supported Files

Issue Files scanned by the Advanced Web Scanner do not get transferred to Ephesoft Transact. Error Stack Trace: Caused by: com.ephesoft.dcma.core.exception.DCMAApplicationException: Batch Contains all Non-supported File. So, Throwing BI3F9 into ERROR. at com.ephesoft.dcma.imp.FolderImporter.deleteInvalidOfficeFiles(FolderImporter.java:2209) at…

Security & Compliance | HTML5 Web Scanner

What's New in Transact 4.1? Security & Compliance | HTML5 Web Scanner Ephesoft Transact browser based scanning tool. Addressing the phasing out of ActiveX and NPAPI plugins used by the browsers. Supports http and https protocol. Supports all TWAIN & PAPER STREAM driver scanners. Supports Automatic/Manual installation modes. Documentation Link to…

Web Scanner

The existing Web Scanner mechanism was not supported by all the browsers and required changes in the methodology. The Advanced Web Scanner Service provides a more secure and improved process of scanning the images. User can download the Advanced Web Scanner Service on their client machines. And can configure the switch for storing the scanned images on the local system or server (TIFF files will…

KB0009823 [com.ephesoft.dcma.core.service.ServerHeartBeatMonitor] – Fatal transport error

Applicable Ephesoft Transact Versions: 4.x Issue:  A server may be down if the following error log is reported: – Fatal transport error The heartbeat service is responsible for checking whether the servers registered in the database are still active. This is important for service failover assignments. However, if the reported server is active, then the following may apply:…

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 Configure Active Directory Using the Standard LDAP Service Port

By default, MS Active Directory supports all LDAP connections using the Standard 389 port. You can configure Ephesoft to do the same by following the instructions below. Applicable Ephesoft versions: Ephesoft v4.x and up 1. First you have to configure the Active Directory to pull the groups so you can set the role(s) for the batch classes. To do this you will modify the…

How to Configure Active Directory Using the Global Catalog Service Port

Topic: Configuring your Ephesoft Installation to Authenticate with AD using the Global Catalog port. By using Global Catalog service you are able to simply use root domain (Domain components DC only) as user base and role base for authentication using LDAP/MS Active directory. This makes it so you simply have to use a single and convenient realm configuration to handle all authentication…