Ephesoft Cloud HyperExtender Plugin

Introduction

This document provides information about the Ephesoft Cloud HyperExtender plugin for Ephesoft Transact, Version 2019.1. This plugin requires registration, licensing, and configuration.

For Transact customers open to cloud processing and who have extensive document processing needs, the Ephesoft Cloud HyperExtender plugin leverages high-performance cloud image processing that can scale.

The Ephesoft Cloud HyperExtender plugin addresses the heaviest processing needs of the Transact workflow.

Note: The Ephesoft Cloud HyperExtender Plugin only supports PDF and TIF formats.

Technical Notes and Restrictions

  • The Ephesoft Cloud HyperExtender plugin switch is enabled (ON) by default.
    • This switch must remain ON to use this plugin.
    • After completing the procedures in this document, the CLOUD_HYPEREXTENDER_PLUGIN is contained in the Folder Import module.
  • The Ephesoft Cloud HyperExtender is only available in the USA.
  • The Ephesoft Cloud HyperExtender only supports PDF and TIF document formats.
  • The Ephesoft Cloud HyperExtender plugin is available in the user interface only for Release 2019.1, and does not support Web Services. Traditional Transact Web Services are not impacted.
  • The combination of Windows OS and Oracle 12c does not work with the Ephesoft Cloud HyperExtender plugin. Ephesoft will address this limitation in a future software release.
  • The Ephesoft Cloud HyperExtender plugin uses the Nuance Omnipage OCR engine version 19.2

Ephesoft Transact Overview

Ephesoft Transact is an intelligent document capture and data classification solution that extracts meaningful data from documents no matter the format or how you receive them. That data then feeds your back-office applications and line of business processes to accelerate the pace of business transactions. Ephesoft Smart Capture solutions can identify the information you need without manual data entry, time consuming document sorting or scanning separator sheets with barcodes.

It is a zero-footprint, browser-based application that can run on your servers behind your firewall, or in the cloud as a subscription-based service. In either model, you can be in production in days, rather than the weeks or months of setup required with outmoded systems. If you have paper or electronic documents that drive your sales orders, insurance claims, mortgages, invoices or any other business critical process, you need to investigate Smart Capture solutions from Ephesoft.

Ephesoft Transact is the only document capture and extraction system to employ RESTful APIs, which enable document capture for ERP, CRM, document management, and other back-office and personal productivity programs.

For additional information about Ephesoft Transact, refer to the following resources:

  • Ephesoft Transact User Quick Reference Guide

https://ephesoft.com/docs/ephesoft-transact-quick-reference-guide

  • Ephesoft Transact 4.5 Getting Started Tutorial

https://ephesoft.com/docs/getting-started/ephesoft-transact-4-5-getting-started-tutorial/

Deployment Overview of the Ephesoft Cloud HyperExtender Plugin

Configuring and using the Ephesoft Cloud HyperExtender plugin entails the following general tasks:

1. Installing the Ephesoft Transact Server, with any of these methods:

  • Local installation
    • Windows
    • Linux
  • Cloud installation
    • Amazon Web Services (AWS)
    • Azure

2. Starting the Ephesoft Transact Server

3. Learning or training one or more documents

  • Using the standard plugins in the Folder Import and Page Process modules

4. Removing the standard plugins from the Folder Import and Page Process modules

5. Adding and configuring the new CLOUD_HYPEREXTENDER_PLUGIN

  • Adding then enabling the plugin02

6. Restarting the Transact server

Configuring the Ephesoft Cloud HyperExtender Plugin

This section provides instructions for configuring the Ephesoft Cloud HyperExtender plugin.

The overall scope of deploying this cloud-enabling plugin entails the following tasks:

Ephesoft Transact setup [prerequisite] — Local installation and licensing of Ephesoft Transact 2019.1 on premise:

  • Installation and Upgrade

https://ephesoft.com/docs/2019-1/installing-upgrading/

  • Licensing | Licensing Ephesoft Transact 2019.1

http://• https://ephesoft.com/docs/2019-1/installing-upgrading/licensing/licensing-transact-2019-1/

  • Cloud account [this document] — Configuring the cloud account
  • Plugin configuration [this document] — Running one or more batch instances to train existing plugins, then configuring the Cloud HyperExtender plugin to one or more batch classes.
    • These tasks emphasize the Folder Import and Page Process modules.
  • Workflow with cloud integration [other documents] — Running batch instances in production:
  • Document Import [other documents] — Cloud HyperExtender supports multiple document ingestion models
  • Cloud processing — Off-loads portions of the Transact workflow to the cloud for processing

General Prerequisites

Installation and Configuration of Ephesoft Transact Cloud

This section requires that the following preparations to be completed before performing any cloud deployment tasks:

  • Ephesoft Transact and cloud account creation must be complete, with proper licensing.
  • License Requirements — A valid Ephesoft Transact license is required, including licensing for Transact 4Invoice and Transact 4Mortgage, as applicable.
  • Supported Volume — For the Ephesoft Cloud HyperExtender plugin, 1,000 images may be processed per month at no cost.

Preconfiguring for the Ephesoft Cloud HyperExtender Plugin

There are two pre-configuration tasks to perform, prior to configuring the Ephesoft Cloud HyperExtender plugin:

Training Plugins in the Folder Import and Page Process Modules

Prerequisite

Ensure that the following preparation is completed prior to performing the steps in this task:

  • Ephesoft Transact and cloud account creation must be complete, with proper licensing.

Procedure

The Ephesoft Cloud HyperExtender plugin replaces the following plugins in Transact.

IMPORTANT: These batch class plugins must be TRAINED FIRST and then REMOVED prior to configuring the Ephesoft Cloud HyperExtender plugin.

Plugin Workflow Module in a Batch Class
IMPORT_MULTIPAGE_FILES Folder Import
IMPORT_BATCH_FOLDER Folder Import
CREATE_OCR_INPUT Page Process
RECOSTAR_HOCR/NUANCE_HOCR/TESSERACT_HOCR Page Process
CREATE_DISPLAY_IMAGE Page Process
CREATE_THUMBNAILS Page Process

Perform these steps to train batch class documents with these plugins:

1. Launch Transact and navigate to Administrator > Batch Class Management.

2. Log in as prompted. The Batch Class Management screen displays all existing batch classes.

3. Open each batch class to be configured for Ephesoft Cloud and the Ephesoft Cloud HyperExtender plugin.

4. For each batch class, import, learn and process documents to “learn” them, using the standard workflow.

5. Click Apply and Deploy and save the changes.

For more information about training these plugins, and performing basic learn operations in the workflow, refer to the following resources:

  • Ephesoft Transact 4.5 Getting Started Tutorial

https://ephesoft.com/docs/ephesoft-transact-4-5-getting-started-tutorial

  • Plugin Configuration

https://ephesoft.com/docs/2019-1/moduleplugin-configuration/

Removing Existing Plugins from Folder Import and Page Process Modules

Prerequisites

Ensure that the following preparations are completed prior to performing the steps in this task:

  • Ephesoft Transact and cloud account creation must be complete, with proper licensing.
  • Train these plugins prior to removing them. Refer to the following procedure, if required:
    • Ephesoft Transact 4.5 Getting Started Tutorial

https://ephesoft.com/docs/ephesoft-transact-4-5-getting-started-tutorial

Procedure

Once you have trained the plugins cited in the previous procedure, you must remove these plugins from the batch class before adding the Ephesoft Cloud HyperExtender plugin:

Plugin Workflow Module in a Batch Class
IMPORT_MULTIPAGE_FILES Folder Import
IMPORT_BATCH_FOLDER Folder Import
CREATE_OCR_INPUT Page Process
RECOSTAR_HOCR/NUANCE_HOCR/TESSERACT_HOCR Page Process
CREATE_DISPLAY_IMAGE Page Process
CREATE_THUMBNAILS Page Process

Perform the following steps to remove these plugins:

1. Launch Transact and navigate to Administrator > Batch Class Management.

2. Log in as prompted. The Batch Class Management screen displays all existing batch classes.

3. Select (highlight) the batch class to be modified and click Open. The modules and other components of this batch class appear on the left.

4. Expand the Folder Import and Page Process modules.

The following diagram identifies the plugins that must be removed from this batch class before configuring the Ephesoft Cloud HyperExtender plugin.

Note: These are the plugins which you remove in the next few steps.

Plugins to Remove from the Batch Class for Cloud

5. Select (highlight) the Folder Import module. The plugins that are enabled for this module appear on the right in the Selected Plugins field. Remove the plugins from this module.

Plugins selected for the Folder Import module

 

a. Select (highlight) the first plugin — IMPORT_MULTIPAGE_FILES. Move it from the Selected Plugins field to the Associated Plugins field by clicking the left arrow.

b. In the same way, move the IMPORT_BATCH_FOLDER plugin to the Associated Plugins field.

c. Save your changes. Click Apply, Deploy, then Close.

6. Browse to the Page Process module. The plugins that are currently enabled for this module appear in the Selected Plugins field.

7. If any of the following plugins appear in the Selected Plugins field, move them to the Associated Plugins field with the method used in step 5:

  • CREATE_OCR_INPUT
  • RECOSTAR_HOCR
  • NUANCE_HOCR
  • TESSERACT_HOCR
  • CREATE_DISPLAY_IMAGE
  • CREATE_THUMBNAILS

8. Save these changes to the batch class. Click Apply, Deploy then Close.

For additional information about removing or configuring plugins within the Transact workflow, refer to the following resource:

  • Plugin Configuration

https://ephesoft.com/docs/2019-1/moduleplugin-configuration/

Configuring Ephesoft Transact for the Ephesoft Cloud HyperExtender Plugin

This topic describes how to register and configure the Ephesoft Cloud component of the Application. This means registering then configuring the cloud account for Ephesoft Transact.

Accessing Ephesoft Cloud Settings

Prerequisites

Ensure that the following preparations are completed prior to performing the steps in this task:

  • Ephesoft Transact must be installed for the deployment.
  • Each batch class that is to use the Ephesoft Cloud HyperExtender plugin must be trained by using the original plugins for the Folder Import and Page Process modules of the workflow.
  • These plugins must be removed from each batch class that will use the Ephesoft Cloud HyperExtender plugin.

Procedure

This task is to be performed by the System Administrator. Perform the following steps to access the Ephesoft Cloud settings.

If you are already logged into Ephesoft Transact, skip ahead to step 3.

1. Launch Ephesoft Transact, expand the Administrator menu, and click Batch Class Management. The system prompts you to log in.

Administrator menu during launch

2. Log into Transact with the proper Username and Password.

Login screen

 

Expand navigation pane

3. Alternatively, if you are already logged into Ephesoft Transact, expand the navigation on the left. Hover the mouse over the triangle on the left-hand side. This opens a hidden side navigation menu.
Administrator menu in navigation pane

4. Select System Configuration from the Administrator menu. This launches the Application navigation on the left side of the screen.

5. Select and expand the Ephesoft Cloud component.

Ephesoft Cloud component of the Application menu

This displays the Register and Configure components.

Ephesoft Cloud components

Registering for Ephesoft Cloud

6. Click Register.

Register in the Ephesoft Cloud

The Registration screen appears. Complete the registration.

Ephesoft Cloud Registration screen

This screen has the following fields:

  • First Name — Enter the user’s first name.
  • Last Name — Enter the user’s last name.
  • Email Address — Enter the administrator email address for this deployment of Ephesoft Transact in the cloud.
  • Company Name — Enter the company name on record with Ephesoft.

7. Select Register.

a. An email is sent by no-reply@ephesoftcloud.com containing a temporary password.

Click Complete Registration

b. Click on the Complete Registration link in the email and follow instructions to select a permanent password.

c. Once a permanent password is provided, a final email is sent from no-reply@ephesoftcloud.com containing all the pertinent information for configuration.

Account ID, User Name and Application dialog

Configuring Ephesoft Cloud

This topic describes the steps required to configure cloud connection details for the Ephesoft Cloud HyperExtender plugin:

Prerequisites

Ensure that the following preparations are completed prior to performing the steps in this task:

  • Ephesoft Transact must be installed for the deployment.
  • Each batch class that is to use the Ephesoft Cloud HyperExtender plugin must be trained by using the original plugins for the Folder Import and Page Process modules of the workflow.
  • These plugins must be removed from each batch class that will use the Ephesoft Cloud HyperExtender plugin.
  • The System Administrator must be registered for Ephesoft Cloud.

Procedure

The System Administrator must perform this task. Perform the following steps to set up Ephesoft Transact for the Cloud HyperExtender plugin, after completing the earlier procedures:

1. Open Ephesoft Transact.

2. Navigate to Administrator > Batch Class Management. Log in as prompted.

3. Navigate to System Configuration > Ephesoft Cloud > Configure. The Cloud Connection Details screen appears.

Cloud HyperExtender Connector screen

4. Complete the Cloud Connection Details with information provided in the email example above in step 7c.

Cloud HyperExtender Connector screen (complete the fields shown)

5. Click Save.

6. Once the details are saved, it is possible to edit in the case of an error. Click Edit as prompted.

Edit option in the Cloud Connection Details screen

7. Adjust the settings as required and save the changes.

Configuring the Batch Class

Prerequisites

Ensure that the following preparations are completed prior to performing the steps in this task:

  • Ephesoft Transact must be installed for the deployment.
  • Each batch class that is to use the Ephesoft Cloud HyperExtender plugin must be trained by using the original plugins for the Folder Import and Page Process modules of the workflow.
  • These plugins must be removed from each batch class that will use the Ephesoft Cloud HyperExtender plugin.
  • The System Administrator must be registered for Ephesoft Cloud.

Refer to earlier procedures in this document for additional information.

Procedure

1. Launch Ephesoft Transact, expand the Administrator menu, and click Batch Class Management. The system prompts you to log in.

Administrator menu during launch

2. Log into Transact with the proper Username and Password.

Login screen

3. The Batch Class Management screen appears.

Batch Class Management screen

4. Select the batch class to configure from the Batch Class Management screen.

5. Select Open.

6. Perform document training or document learning within the batch class.

As necessary, refer to the following Wiki articles for more information about document learning and basic operations:

  • Ephesoft Transact User Quick Reference Guide

https://ephesoft.com/docs/ephesoft-transact-quick-reference-guide

  • Ephesoft Transact 4.5 Getting Started Tutorial

https://ephesoft.com/docs/ephesoft-transact-4-5-getting-started-tutorial

7. Once document learning is complete, make changes to the Folder Import and Page Process modules, as follows:

a. Folder Import module:

Remove the following two plugins by selecting each, then clicking the left arrow, moving them from the Selected Plugins field to the Associated Plugins field:

  • IMPORT_MULTIPAGE_FILES
  • IMPORT_BATCH_FOLDER
Folder Import Module plugins

b. Page Process module

Remove the following plugins by selecting each, then clicking the left arrow, moving them from the Selected Plugins field to the Associated Plugins field:

  • CREATE_OCR_INPUT
  • RECOSTAR_HOCR/NUANCE_HOCR/TESSERACT_HOCR
  • CREATE_DISPLAY_IMAGE
  • CREATE_THUMBNAILS
Page Process Module plugins

8. For Folder Import, drag and drop the CLOUD_HYPEREXTENDER_PLUGIN from list of plugins into Selected Plugins.

CLOUD_HYPEREXTENDER_PLUGIN

9. Select the CLOUD_HYPEREXTENDER_PLUGIN plugin OCR folder.

Folder Import module

10. Select Configure.

Cloud HyperExtender Plugin > Configure Screen

Note: The Data Center drop down only shows countries the System Administrator has enabled during the registration process. It is not possible to select a Product other than OCR+.

11. Select the OCR language or languages to support in this batch class. Once complete, click Save. Transact supports the selection of more than one OCR language.

12. Open the hidden left-hand menu and select Upload Batch Class.

13. Select files by clicking Selecting Files or drag and drop files in the appropriate box.

Selecting Files for Upload

14. Select the uploaded file.

Selecting Files for Upload

15. Select the specific batch class that has the CLOUD_HYPEREXTENDER_PLUGIN configured.

Selecting Batch Class

16. Start batch processing using the Ephesoft Cloud HyperExtender plugin.

IMPORTANT: Do NOT restart a running batch.

Properties File Configurations for the Ephesoft Cloud HyperExtender Plugin

The following two properties files in Ephesoft Transact may require adjustment to achieve higher performance and increase throughput:

workflow.properties File

application.properties File

Refer to the following resources for additional information about accessing and configuring these properties files:

  • Ephesoft Transact User Quick Reference Guide

https://ephesoft.com/docs/ephesoft-transact-quick-reference-guide

  • Ephesoft Transact 4.5 Getting Started Tutorial

https://ephesoft.com/docs/ephesoft-transact-4-5-getting-started-tutorial

  • How to Configure the Workflow Properties

https://ephesoft.com/docs/how-to-configure-the-workflow-properties/

  • Application.properties

https://ephesoft.com/docs/configurations/transact-property-file-reference-guide/application-properties/

Workflow.properties File

This file allows you to increase the number of parallel batch processing for optimizing cloud operations:

#server.instance.max.process.capacity.mode governs the calculation of server.instance.max.process.capacity value.
#0 means calculation will be dynamic that depends on system configurations and results of performance testing.
#1 means calculation will static and value will be picked from the property server.instance.max.process.capacity
server.instance.max.process.capacity.mode=0
server.instance.max.process.capacity=5

Changing the server.instance.max.process.capacity.mode from 0 (default) to 1 and setting the max.process.capacity can increase the number of parallel batches processing that can occur.

  • For Smaller Size Batches (~100 page batch): We recommend setting max.process.capacity between 15 and 20 for maximum performance. This number should be brought back down to 5 (default) when processing on-premise only.
  • For Larger Size Batches (~1000 page batch): Keep default setting.

Transact.us.ephesoftcloud.com Portal Page

Users can log in to the Ephesoft Cloud portal page to view how many images have been consumed.

Ephesoft Cloud Portal

Troubleshooting the Ephesoft Cloud and Ephesoft Cloud HyperExtender plugin

Incomplete Registration

1. If the Batch Class Administrator tries to configure the CLOUD_HYPEREXTENDER_PLUGIN with connection details not provided by the System Administrator, the following error message appears:

Cloud HyperExtender Plugin Screen — Registration is Incomplete message

2. Contact the System Administrator.

Test Classification and Extraction

When the Ephesoft Cloud HyperExtender plugin is configured and running in Ephesoft Transact, the Test Classification and Test Extraction functions will not work correctly. You will encounter the following error message:

Error in Test Classification