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…

KB0021804: Sharepoint Office365 Cloud Export: Cannot reach web service right now

KB Articles KB Article # 21804 Topic/Category: Sharepoint Office 365 Export Issue: When configuring Sharepoint Office365 Cloud Export, the following message may be encountered: "Cannot reach web service right now..." Solution: There are 2 details about sharepoint that should be checked: privileges and subsites Regarding Privileges: Insure account has global administration…

KB0019641:How to enable WEB SERVICE CALLS with SSO

KB Article # 19641 Topic/Category: Web Services over SSO Applies to: Ephesoft Transact 4.x version Issue: How to make Web Service calls when Ephesoft is configured with SSO Root Cause: Missing functionality Solution:  Currently call to rest API's works with basic authentication only and below steps needs to be followed for the same: Uncomment the…

KB0013586 – Performance issue using Recostar extraction with Web Service API

KB Article #: 13586 Issue: User creating many SubForms within one recostar project and had many recostar projects for the document First Second Third and last pages. When searching each subform it performs OCR in the desired area the user chooses in the project. When user is choosing the entire page for every SubForm created making Recostar perform OCR on the entire page many times.…

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. On performing volume testing for this web service, and based on customer feedback, we identified areas in the code base for this web service which can be optimized. Starting with the v4.1.2.0 release of Ephesoft…

Integrating Transact Web Services with Nintex

Two Transact web services, v2/ocrClassifyExtract and v2/ocrClassifyExtractBase64, have been optimized specifically to work with advanced workflow engines. This document provides an example of how to integrate these web services with the Nintex workflow engine. For example, a workflow can easily be constructed to monitor Box to look for any new invoices created in the “Incoming” folder. When a…

Certificate error while using web scanner module – EphesoftTransactScannerService

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 EphesoftTransactScannerService. Version : 4.5.0.0 , 4.5.0.1 Screenshot: Browse to…

404 Not Found Error Returned When Running a Web Service

Applies to: All Versions of Ephesoft Issue: 404 Not Found Error Returned When Running a Web Service   Solution:    The fully-qualified path for a web service call needs to follow exact naming conventions when calling the web service, including the capitalization of specific letters in the web service name. Failure to do so will result in the 404 Not Found Error when…

Export | Custom Export to Web Services Guide

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 Transact. You…

EphesoftWebService installation

Depending on the user requirement, the EphesoftWebService has to be installed manually, after the Ephesoft Transact installation. To install the service, navigate to the Apache24 folder (path: <Ephesoft Installation Directory>\Apache24) and run the installandstart.bat file. When facing any issues with the EphesoftWebService re-installation/update (if the service has already been…

KB0027046: How to authenticate web services through SSO

Issue Description: How to authenticate web service API If SSO as authentication type is configured in Ephesoft Transact. Component: SSO & Web Services Solution: Currently there are some limitations to authenticate web services through SSO. However you can follow below steps for Web Service API's to work with SSO: Steps to authenticate REST service along with SSO using…

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…

KB0020066 : Batch Instance in CREATED state when uploaded using uploadBatch() Web Service

KB Article # 20066   Topic/Category: Web Service   Applies to: Ephesoft Transact 4.x   Issue: Issue is observed when we are able to upload the folder, files in the UNC folder successfully with uploadBatch() Web Service and getting a Response 200 code. A database entry is created in batch_instance table with status "CREATED" in the database. This…

IIS: Incorrect Error Message being thrown from Web Services

Issue Details: Seeing a different error message from web service other than the already configured error message. For Example: We are getting a different error message with copyDocumentType Web Service when the document type already exist. Expected message:“name entered for new doc type already exist. please enter a unique document name” Actual Message: “The custom error module does…

KB0014664: Spike in CPU After Installing Web Scanner Service

Users with Ephesoft 4.1.1.0 may see a potential issue with the Web Scanner Service for version 4.1.1.0, where leaving the installed service running on a workstation causes a sudden and unexpected spike in the workstation CPU. Current workarounds to bypass the issue were to kill the ScannerUIEnabler.exe process from Task Manager, or to disable or uninstall the service.   This issue has…

KB0013461 – Office 365 Cannot connect to webservice Sharepoint

KB Article #: 13461 Applies to: v4.0.6.0 and above. Issue: The logs have an issue to log in to sharepoint at ephesoft.sharepoint.com. See error below: 4.0.6.0 Windows Server 2012 2016-08-24 06:02:14,894 ERROR http-apr-8080-exec-2 com.ephesoft.gxt.admin.server.BatchClassManagementServiceImpl - Illegal Share point credentials.…

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. If you have not yet installed Web Scanner, complete the instructions provided in the Web Scanner Installation…

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…

KB00023071: Web Scanner Certificate Expiration in Ephesoft 4.5 and 4.1.3.0

Component: Ephesoft Transact 4.1.3.0 and 4.5.0.0   Issue Description: On accessing the web-scanner URL we are prompted with below certificate expiration message: and on clicking View Certificate we are prompted with Expired Certificate Information as below: Root Cause: Ephesoft Scanner Service self signed certificate for ssl configuration got expired. This is…

KB00022795: Webapps no longer auto-deploy on Transact 4.5

KB Article # 22795 Topic/Category: Webapps Applies to: 4.5 Issue: In previous versions of Transact, when placing a webapp .war file into the webapps folder and it will automatically be deployed. In 4.5, a service restart is required. Root Cause: Auto deploying web apps was considered a security risk and has been disabled by default Solution: User can enable the function but…

KB00022812: Web Scanner: Issue with Single Page Scanning leaving Finish button disabled

Component: Web Scanner   Affected Version: All Ephesoft Transact Versions and scanner specific as well.   Issue Description: On scanning a single page the Finish button is not enabled. It only gets enabled only when another page is scanned. This issue is with default profile that is present by default.   Root Cause: Bug in Web Scanner component 4.5.0.0 and…

Known Issue: Invalid Access Error Using Advanced Web Scanner with Ephesoft 4.5.0.0 and above

Known Issue: Invalid Access Error Using Advanced Web Scanner with Ephesoft 4.5.0.0 and above Scanner operators attempting to use the Ephesoft Advanced Web Scanner with Ephesoft version may see the following error pop-up: In Transact 4.5.x.x In Transact 2019.1 In Transact 2019.2 If you see this error, please check the Ephesoft Scanner Service version currently installed in…

KB0022056: Advanced Web Scanner Throwing Error that Twain is not Available

When attempting to use the Advanced Web Scanner service in conjunction with Ephesoft, you may receive a report from the scanner operators that they are not able to successfully upload a scan job. When the scanner operators start a scan job, they may see the UI freeze without adding any of the pages. If you take a look at a user's Web Scanner logs (found on the user workstation typically at…