Ephesoft Cloud HyperExtender Plugin 2020.1


This document outlines 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.

This plugin is currently only available to customers in the United States.

The following image illustrates the CHE plugin workflow within Ephesoft Transact.

A screenshot of a cell phone Description automatically generated

Figure 1. Cloud HyperExtender Workflow


The Cloud HyperExtender (CHE) plugin requires the following:

  • A licensed version of Ephesoft Transact 2019.1 or above
  • A licensed version of the Ephesoft Cloud HyperExtender plugin
  • An active Ephesoft Cloud account

Functional Limitations

Below are key functional limitations for the CHE plugin:

  • English is currently the only language supported for OCR processing.
  • Supports file sizes up to 250MB.
  • PDF files uploaded in color will be returned with thumbnails in black-and-white.
  • Does not support the following Transact functions:
    • eText extraction
    • Web scanner imprint
    • Test Classification
    • Test Extraction
  • Only supports PDF and TIFF files in non-zip format, and the following import file types:
    • Searchable
    • Tabbed
    • PDF/A-1B
    • PDF/A-2b
    • PDF/E
    • PDF/X-4
  • Only supports the following web services:
    • uploadBatch
    • advancedUploadBatch
    • copyBatchClass
    • exportBatchClass
    • importBatchClass

Note: Web services that directly communicate with the OCR process (OcrClassify, OcrClassifyExtract, v2/ocrClassifyExtract, and v2/ocrClassifyExtractBase64, etc.) cannot interact with a batch class that has been configured to use CHE. For additional information about Ephesoft Transact web services, refer to Web Services Explorer.

Registration and Configuration

An Ephesoft Cloud account is required to use the Cloud HyperExtender (CHE) plugin. Follow these instructions to register for an account and configure CHE with the Ephesoft Cloud.

Note: You must be logged into Ephesoft Transact as a Super Administrator to complete the steps below.

Registering for the Ephesoft Cloud

  1. In Ephesoft Transact, hover over the floating menu on the left side of the application. The Administrator menu displays.

Figure 2. Floating Menu

Figure 3. Administrator Menu in the Navigation Pane

  1. Select System Configuration > Ephesoft Cloud > Register (Figure 4). The Registration screen displays (Figure 5).

Figure 4. Ephesoft Cloud Components

Figure 5. Ephesoft Cloud Registration Screen

  1. Complete all blank fields. Click Register. An email containing a temporary password will be sent to the email address provided.

Note: An email address can only be registered once for an account.

  1. From the email, click the Complete Registration link and use the above credentials to register.

A screenshot of a social media post Description automatically generated

Figure 6. Temporary Password Email

  1. Follow the instructions on the registration page to set a new password using the temporary password from Step 3.
  2. Verify that you received an email containing all the information necessary to configure your connection to the Ephesoft Cloud: Account ID, User Name, and Application Key.


Figure 7. Account ID, User Name, and Application Key Dialog

Note: If prompted with the error message “Ephesoft Cloud registration is incomplete,” please check the Connection Details again or contact your System Administrator.

This completes your Ephesoft Cloud registration.

Connecting CHE with the Ephesoft Cloud

Once you have received your Ephesoft Cloud credentials, follow these steps to configure Ephesoft Transact to communicate with the Ephesoft Cloud.

  1. In Ephesoft Transact, hover over the floating menu on the left side of the application and select System Configuration > Ephesoft Cloud > Configure. The Cloud Connection Details screen displays.

Figure 8. Ephesoft Cloud HyperExtender Connector Screen

  1. Complete the fields in the Cloud Connection Details screen using the credentials (Tenant ID, email address, and application key) that were sent to you via email in the previous step.

Note: The Tenant ID may be referred to as Account ID in the email that was sent.

  1. Click Save. Click Edit if additional changes are needed.

Note: Once CHE is configured, you can log in to the Ephesoft Cloud portal to view the number of images you have processed using CHE.

A screenshot of a cell phone Description automatically generated

Figure 9. Ephesoft Cloud Portal

This completes the steps required to connect CHE with Ephesoft Cloud. CHE is now ready to be configured within Ephesoft Transact.

Configuring a Batch Class to Use CHE

The Cloud HyperExtender (CHE) plugin replaces several existing plugins in the Folder Import and Page Processing modules. Follow these steps to configure your batch class to utilize CHE.

Note: Extraction rules cannot be configured within the CHE plugin. All configurations must be completed within the existing plugins before turning on CHE. To configure additional extraction rules, you must turn off CHE and replace the original plugins in the batch class.

  1. Log in to Ephesoft Transact as either a Super Administrator or Batch Class Administrator and navigate to the Batch Class Management screen.
  2. Open the desired batch class for editing.
  3. On the left sidebar, navigate to Modules.
  4. Edit the Page Process and Folder Import modules as follows:

4.1. Remove the following plugins from the Page Process landing screen:


A screenshot of a cell phone Description automatically generated

Figure 10. Page Process Module Plugins

4.2. Remove the following two plugins from the Folder Import landing screen:


A screenshot of a cell phone Description automatically generated

Figure 11. Folder Import Module Plugins

4.3. Add the CLOUD_HYPEREXTENDER_PLUGIN to the Folder Import module.

A screenshot of a cell phone Description automatically generated


4.3. Click Deploy to apply and deploy your changes.

4.4. Expand the CLOUD_HYPEREXTENDER_PLUGIN component and click Configure. The Ephesoft Cloud HyperExtender configuration screen displays.

Important: For customers using Transact 2020.1, the Auto Rotate feature is set to ON by default. Auto Rotate can be turned off to improve performance while using CHE. To disable Auto Rotate in batch classes that will use CHE, open the CHE plugin in the Folder Import module and switch Auto Rotate to OFF.

A screenshot of a social media post Description automatically generated

Figure 13: Ephesoft Cloud HyperExtender 2020.1 Configuration Screen

Note: USA is the only option available in the Data Center list, and OCR+ is the only option available in the Product list. English is currently the only language supported for OCR processing. Once English is selected, click Save to enable CHE.

  1. Verify the Batch Class priority settings. To preserve CHE’s processing speed, ensure all CHE batch classes are set to priority 1, and manually adjust non-CHE batch classes to priority 2. For more information on setting batch class priorities, refer to the Batch Instance Priority guide.

This completes the CHE configuration within Ephesoft Transact. Your batch class is now ready to process documents using the CHE plugin.

User Instructions

  1. Refer to the following article for instructions on How to Process Batches Using Transact.

Note: Any batch class configured to utilize CHE will follow the same steps as a standard Ephesoft Transact workflow. From the Transact home screen, CHE will communicate with Ephesoft Cloud to complete batch OCR processing, with no additional action required by the operator.

If a batch fails during the OCR process, the images in that failed batch will not be consumed from the image quota specific to your CHE license.

  1. For troubleshooting purposes, the CHE log file can be accessed at the following location: <Ephesoft Installation Folder>JavaAppServer/webapps/ephesoft-cloud-client/WEB-INF/classes/log/cloud-client.log

Optional Feature

Bring Your Own Key

This section provides an overview of Bring Your Own Key (BYOK), an optional feature for the Cloud HyperExtender (CHE) plugin. To add this feature to your version of CHE, contact Ephesoft Support.

The Bring Your Own Key (BYOK) feature provides increased security protection, as it ensures that encrypted files can only be decrypted by the customer.


  • Once the BYOK feature is enabled, the feature cannot be disabled. The option to have Ephesoft provide a key will no longer be available.
  • DO NOT lose the encryption key. If the encryption key is lost, you cannot decrypt your files. Ephesoft will not have the ability to decrypt files on your behalf.

Enabling BYOK

  1. Generate an AES 256-bit security key. Ensure it is encoded as a Base64 string.
  2. Open the following folder: <Ephesoft installation folder>/JavaAppServer/webapps/ephesoft-cloud-client/WEB-INF/classes
  3. Open the application.properties file to edit.

Note: If you have a clustered Transact environment with multiple processing servers, ensure that you edit this file on each processing server.

  1. Enter the security key from step 2 in this string of text after the equal (=) sign: cloud.workflow.encryption-key=<your security key> on each of the processing servers application.properties.
  2. Restart the Ephesoft Transact service.

This completes the user instructions for the CHE.