Licensing Ephesoft Transact 4.5.0.x

Introduction and Overview

This article describes the licensing options for Ephesoft Transact 4.5.0.x on Windows and Linux systems. This information covers new installations or upgrades from previous releases.

  • June, 2018 — This document was originally published to support Ephesoft Transact 4.5.0.0.
  • October, 2018 — This document was updated for Ephesoft Transact 4.5.0.2 to mention new support for Transact 4Mortgage.

Licensing in Ephesoft Transact 4.5.0.x

Licensing Changes for Ephesoft Transact 4.5.0.x

In releases of Ephesoft Transact prior to Release 4.5.0.0, the Ephesoft Transact license was not specific to the operating system. The same license could be used for both Windows and Linux.

Effective with Ephesoft Transact v.4.5.0.0, the licensing policy has become OS-specific. Ephesoft now issues separate licenses for Ephesoft Transact as follows:

  • Microsoft® Windows
  • Linux
  • Both operating systems

This licensing change was introduced with Release 4.5.0.0, March 2018, in the following wiki article:

  • Licensing Policy Changes in Ephesoft Transact 4.5.0.0

http://wiki.ephesoft.com/home/documentation/licensing-policy-changes

For additional licensing information about Ephesoft Transact 4.5.0.x, refer to the following document:

  • Transact 4.5.0.x Release Notes (see “Licensing” topics)

http://wiki.ephesoft.com/home/release-notes

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

  • Ephesoft Transact 4.5.0.x Product Documentation

https://wiki.ephesoft.com/home/documentation

Licensing Topology for Ephesoft Transact 4.5.0.x

This topic describes the Support plans and core licensing methods of Ephesoft Transact 4.5.0.x.

Support Plans — The two support plans for Ephesoft Transact 4.5.0.x are as follows:

  • Platinum Support is for 24/7 support, multi-core installation, with high availability and clustering. To license Ephesoft Transact 4.5.0.x on a multi-core installation, you require the Platinum Support plan.
  • Gold Support is for 8 hours a day, 5 days per week, without high availability or clustering.

Core Licensing — Ephesoft Transact 4.5.0.x uses the following license method:

  • 4-Core Transact license — 1 OCR Core
  • 8-Core Transact license — 4 OCR Cores
  • 16-Core Transact license — 8 OCR Cores
  • 32-Core Transact license — 16 OCR Cores

The following diagram illustrates successful licensing with failover servers and a 60-core cluster. In this configuration, the number of system cores matches the number of cores on the license.

Successful License Setup in a Multi-server Environment

The following diagram illustrates a very similar environment, in which the total number of system cores does not match the number of cores on the license. This scenario would require resolution for a successful deployment.

Incorrect License Setup in a Multi-server Environment

The following resource provides additional information:

  • How to Set Up the Ephesoft License Server

https://wiki.ephesoft.com/how-to-setup-ephesoft-license-server

Additional Licensing Dynamics in Ephesoft Transact 4.5.0.x

Third-Party Engines — Ephesoft Transact integrates OCR engines for Windows and Linux integration.

  • Third-party engines include Recostar, Tesseract and Nuance.
  • Third-party components may be subject to additional licensing considerations or requirements. The following resources provide additional information:

Language and CJKT Licensing — The Fixed-form Template Editor in Ephesoft Transact has licensing requirements or restrictions, as follows:

  • The fixed-form template editor in Nuance does not support CJKT languages (Chinese, Japanese, Korean, and Thai).
  • Additionally, and for Recostar and Nuance, if you wish to use Chinese, Japanese, Korean, Thai, or Arabic, special licensing is required, and additional license costs apply.

Ephesoft Transact 4Mortgage — Ephesoft Transact Release 4.5.0.2 introduces the option of Transact 4Mortgage, which has two options — Standard Mortgage Package and Premium Mortgage package.

  • Either Transact 4Mortgage package requires additional licensing.
  • The Ephesoft Transact License Generator includes new Transact 4Mortgage settings, accessible to Super Administrators who manage licensing.
  • Additional information about Transact 4Mortgage is available from the following documents:

Ephesoft Transact User Quick Reference Guide

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

Ephesoft Transact 4Mortgage White Paper

http://download.ephesoft.com/Ephesoft_Product/Transact_4Mortgage.pdf

Licensing Prerequisites

This document requires that Ephesoft Transact 4.5.0.x be installed and ready for operation. Refer to the following resources for additional information and prerequisites for installation or upgrade:

  • Ephesoft Transact 4.5.0.x | General Documentation

http://demo.ephesoft.com/products/ephesoft-transact/

  • Ephesoft Transact 4.5.0.x | Installation and Feature Documentation

http://wiki.ephesoft.com/home/documentation

  • Licensing | License Server Failover Mechanism

https://wiki.ephesoft.com/license-server-failover-mechanism

Requesting the Transact 4.5.0.x License

To configure, launch and license Transact 4.5.0.x, follow these steps:

1. Install or upgrade Ephesoft Transact 4.5.0.x, as described by the licensing prerequisites.

Determine Cores or Logical Processors

2. Obtain or verify the number of logical processors, cores and the RAM in this installation of Transact 4.5.0.x.

Note:         To determine the number of “cores” on your system, verify the number of logical processors or cores per socket, depending on whether this is a Windows or Linux installation.

Windows — Licensing for Transact observes logical processors on Windows rather than physical cores. The number of Logical processors is the number of Transact cores that you must license for Ephesoft Transact.

a. For Windows, obtain the number of logical processors from the following location:

  • Right click in the Windows Task bar or Start.
  • Click Task Manager > More Details.
  • Click Performance > CPU.
  • View the Logical Processors.

Task Manager > Viewing Logical Processors (Windows)

Linux — Licensing for Linux observes cores per socket.

a. For Linux, obtain this information as follows:

  • One method is to type the lscpu command at the command prompt of the Linux terminal:
[ephesoft@localhost ~]$ lscpu

The system returns the following information. The Core(s) per socket value indicates the number of cores in this deployment.

Viewing Core(s) in Linux

  • Another method to determine the number of CPU cores is to type nproc in the terminal. This command returns the number of cores as an output.

Viewing Core(s) in Linux with the nproc Command

Retrieve and Prepare the details.properties File

3. Retrieve a copy of the properties file from the Transact installation folder.

a. For Windows, you can obtain this file from the following location:

{Installation Folder}\Dependencies\licensing

Transact 4.5.0.x Installation Folder

b. For Linux, navigate to /opt/Ephesoft/Dependencies/licensing and obtain the properties file.

4. Prior to sending this file to Ephesoft Technical Support, please open, review and update the properties file, as necessary.

a. Add each MAC address for this system, as required.

  • MAC address format: The MAC address for your properties file should resemble the format illustrated on the right side of the following snapshot:

MAC Address Formats

  • Obtaining MAC addresses: If the Device Address is missing or appears to be incorrect, please manually populate the file in Notepad with the unique MAC address or addresses from your system.
    • Cite the unique MAC addresses per each network interface card (NIC), or network adapter, that is listed in the properties file.
    • As necessary, if you need to obtain the MAC address for your system, follow this step:
  • Windows: Open a command prompt from the system, then run the ipconfig /all

Note:         The output of this command is already contained in the details.properties file, by default, on Windows systems.

  • Linux: Follow these steps to obtain the MAC address or addresses on a Linux system:

a. As the root user (or user with appropriate permissions), type ifconfig -a.

b. From the displayed information, find eth0 — this is the default first Ethernet adapter.

c. Locate the number next to the HWaddr. This is the MAC address.

  • Paste the MAC address or addresses into the properties file.
  • Save the changes in the properties file.

5. Please send the properties file to licenses@ephesoft.com to receive your license file.

  • Be sure to mention whether your license is a Windows or Linux license. Advise them of the number of CPU cores on the server.

Once you have received the license from Ephesoft, the next step is to install the license.

Refer to one of the following procedures, according to your licensing installation type:

  • Windows: Licensing a New Installation of Ephesoft Transact 4.5.0.x on Windows
  • Windows: Licensing an Upgrade to Ephesoft Transact 4.5.0.x on Windows
  • Linux: Licensing a New Installation or Upgrade of Ephesoft Transact 4.5.0.x on Linux

Licensing Ephesoft Transact 4.5.0.x on Windows

Licensing a New Installation of Ephesoft Transact 4.5.0.x on Windows

Perform the following steps to install the license file for a new installation of Ephesoft Transact.

Note:         If the Ephesoft Licensing team provides alternate instructions, please follow that series of steps instead.

1. If necessary, request and obtain a new license file — lic filename extension — that is compatible with Transact 4.5.0.X. Complete the steps in “Requesting the Transact 4.5.0.x License” (an earlier procedure in this document).

2. Setting the Registry — As a recommended step, if the Windows system has ever had a prior installation of Transact, open the Windows Registry and delete the following key.

HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Prefs\com\ephesoft

Note:         This step only applies when replacing a pre-existing license from a previous installation. This step may be necessary if you receive an error that indicates access privilege issues with the registry in the event log. This error may indicate that you must reset privileges correctly.

Note:         If you adjust settings in the registry, verify that all users are set to have full control.

3. Copy the new lic file to the \Ephesoft\Dependencies\license-util folder.

4. Open the Windows command prompt as an Administrator and navigate to the same \Ephesoft\Dependencies\license-util folder.

5. From this path in the command prompt, type install-license.bat and then press Enter. For consistency, Ephesoft recommends that you run install-license.bat twice to ensure the license correctly applies.

6. You should now see two string values titled system.info and license with data included in them in this registry path:

HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Prefs\com\ephesoft\license\core\annotation

To resolve issues that you may observe after completing the above steps, refer to “Resolving License Installation Issues on Windows” in this article.

Licensing an Upgrade to Ephesoft Transact 4.5.0.x on Windows

Perform the following steps to Install the license file for an upgrade to Ephesoft Transact.

Note:         If the Ephesoft Licensing team provides alternate instructions, please follow that series of steps instead.

1. If necessary, request and obtain a new license file — lic filename extension — that is compatible with Transact 4.5.0.X. Complete the steps in “Requesting the Transact 4.5.0.x License” (an earlier procedure in this document).

2. Copy the new ephesoft.lic file to the \Ephesoft\Dependencies\license-util

Note:         If this is a patch installation, and not a full installation, you may need to rename the file when pasting the copied file to the target folder.

  • If a previous license file exists, Windows will rename the new license file when you paste it to the same location.
  • In this case, you must delete the original license file, then rename the new license file to the original filename — lic.

This folder holds all the dependencies needed to properly install the licensing file and successfully activate Transact. This folder should always be present when running the license installation procedure.

3. Open the Windows command prompt as an Administrator and navigate to the same \Ephesoft\Dependencies\license-util

4. From this path in the command prompt, type install-license.bat and then hit Enter. For consistency, Ephesoft recommends that you run install-license.bat twice to ensure the license correctly applies.

5. You should now see two string values titled system.info and license with data included in them in this registry path:

HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Prefs\com\ephesoft\license\core\annotation

To resolve issues that could arise from certain additional settings, refer to “Resolving License Installation Issues on Windows” in this article.

Starting Ephesoft Transact 4.5.0.x on Windows

To start Ephesoft Transact, perform these steps:

1. In a browser window, enter the URL path for this Ephesoft Transact installation.

http://localhost:8080/dcma/home.html

This will bring you to the home menu for Ephesoft Transact.

Home Menu for Ephesoft Transact

2. Select Administrator or Operator in order to log in.

Click the Administrator or Operator icon will display the screens available for each user type.

Transact 4.5.0.0 home page

3. Enter the Username and Password.

Login Dialog

This takes you to the login screen.

4. Enter the login credentials:

  • Username — enter ephesoft
  • Password — enter demo

Resolving License Installation Issues on Windows

If you observe issues with Ephesoft Transact after completing the above steps, please review the additional wiki articles below for more information about some of the common issues that may occur during license installations.

  • General Issues:

http://wiki.ephesoft.com/general-startup-and-license-issues

  • File Permission Issue:

http://wiki.ephesoft.com/is-your-ephesoft-issue-a-file-permissions-issue

  • IPv6 Issue:

http://wiki.ephesoft.com/license-issue-with-ipv6

  • Starting with UAC on:

http://wiki.ephesoft.com/kb0010118-fresh-install-ephesoft-wont-start-uac-on

http://wiki.ephesoft.com/kb0010118-fresh-install-ephesoft-wont-startconnect-windows-firewall-on

If these suggestions or guidelines do not resolve your issue, please send an e-mail to tickets@ephesoft.com and include your log files from \Ephesoft\JavaAppServer\logs.

Refer to the following wiki article about how to obtain these log files.

Licensing Ephesoft Transact 4.5.0.x on Linux

Licensing a New Installation or Upgrade of Ephesoft Transact 4.5.0.x on Linux

Perform the following steps to install the license file for a new installation of Ephesoft Transact.

Note:         If the Ephesoft Licensing team provides alternate instructions, please follow that series of steps instead.

Note:         Run the license installation procedure from a Linux root user account. In many cases, this will be the sudo account.

1. Install Ephesoft Transact with the instructions provided in the following locations:

  • Primary Instructions:

https://wiki.ephesoft.com/ephesoft-linux-installation

  • Platform Support:

https://wiki.ephesoft.com/platform-configuration-and-third-party-integrations-transact-v-4-5-0-0

  • Ubuntu 14.10 Instructions:

http://wiki.ephesoft.com/installing-ephesoft-on-ubuntu-14-10

  • RHEL without a desktop environment:

http://wiki.ephesoft.com/install-ephesoft-rhel-headless

  • Multiserver installation:

http://wiki.ephesoft.com/rhel-multi-server-installation 

2. If necessary, request and obtain a new license file — lic filename extension — that is compatible with Transact 4.5.0.X. Complete the steps in “Requesting the Transact 4.5.0.x License” (an earlier procedure in this document).

The Ephesoft licensing team will send you a file named ephesoft.lic.

3. Place this file in the /opt/Ephesoft/Dependencies/license-util/ephesoft-license-installer

Folder /opt/Ephesoft/Dependencies/license-util/ephesoft-license-installer

4. While you are still root user and the lic file has been copied to the correct folder, run the following command in the folder mentioned above.

./install-license.sh

Running the ./install-license.sh Command

5. Run the following command a second time to ensure the license was installed correctly:

./install-license.sh

Running the ./install-license.sh Command a Second Time

6. Now that the license has been installed, toggle back to the normal user account, instead of the root user.

This example illustrates the ephesoft user account; the command for this user account would be as follows:

su – ephesoft

This command also returns you to the home directory for your user.

Starting Ephesoft Transact 4.5.0.x the First Time on Linux

1. You can start Ephesoft for the first time after installing the license.

  • Run the following command to start Ephesoft Transact.

sudo /opt/Ephesoft/JavaAppServer/bin/startup.sh

This command must be run with sudo rights.

Ephesoft Transact is now started.

Starting Ephesoft with the sudo /opt/Ephesoft/JavaAppServer/bin/startup.sh Command

2. Open a web browser on the workstation and browse to the following location:

http://localhost:8080/dcma/home.html

This will bring you to the home menu for Ephesoft Transact.

Home Menu for Ephesoft Transact

3. Clicking on the Administrator or Operator icon will display the screen menus available for each user type.

Administrator and Operator Menu Screens

4. Select a screen and the system displays the login prompt.

5. This takes you to the login screen. Enter the login credentials:

  • Username — enter ephesoft
  • Password — enter demo

Login Dialog

Resolving Ephesoft Transact 4.5.0.x License Installation Issues on Linux

1. If you do not have root or sudo permissions on the server, please contact your system administrator for permissions or instructions.

2. If installing the SharedFolders directory on a remote server/NAS/SAN, please advise your system administrator to mount the share locally to your server and use the path they provide during the install. You can contact Support for assistance if you run into issues with this. Persistent mount of the share on the local server will be necessary for Ephesoft Transact to function.

Viewing the License Details Screen in Ephesoft Transact 4.5.0.x

To access and display the License Details screen in Ephesoft Transact 4.5.0.x, you must log in to Transact with super-admin privileges.

Once the license has been installed, click License Details to display the contents and settings of the current license.

The following table describes each component of the Ephesoft Transact License Details screen:

Field or Switch Description
License Expiry Date  Contains the date on which this Ephesoft Transact license expires.
MAC Address Lists the MAC address or addresses associated with this licensed installation.  If this installation has multiple cores, each MAC address is separated by the pipe ( | ) symbol.
Number of Cores       Cites the number or quantity of cores for this licensed installation.
Reporting License Type

 

 

 

 

Identifies the type of reporting functions that are supported in this license. The three options for this field are as follows:

  • Standard — rarely used. This setting means only throughput reports are displayed in the user interface.
  • Advanced — the most common setting. This setting includes throughput reports and correction reports. This setting indicates that grid analysis is enabled in the user interface, allowing the user to choose which columns, fields, and additional details are enabled in the user interface. This setting indicates that the user can also create fields and a dashboard.
  • Advanced with Custom Reporting — rarely used. This setting includes everything from Advanced reporting, but with the additional ability to create a completely different user interface, using the Logi library. This is a development license.
Web Service Switch

 

Indicates whether web service API calls are enabled for service in this installation.This value is set to ON if this installation supports using API service calls.

  • This value is set to OFF if this installation does not use API service calls.
Verify Platinum Switch Indicates whether this installation includes multi-server connectivity (YES) or single-server deployment (NO).
High Performance Switch

 

 

Indicates whether this installation supports 8 cores or above for high-performance OCR functions. Any installation of 8 cores or above allows this switch to be enabled (ON).
Enabling high performance allocates half of the available cores for OCR functions:

  • 8-Core Transact license — 4 OCR Cores
  • 16-Core Transact license — 8 OCR Cores
  • 32-Core Transact license — 16 OCR Cores
License Expiration Display Message Displays the number of days prior to license expiration that the system will begin to prompt users about an upcoming license expiration.
Image Count

 

 

Displays the image count for this license, which may be one of the following:

  • an annual total
  • a subscription total for the life of the subscription, if different than an annual total
  • unlimited
Web Service Hits Per Day Contact Ephesoft Sales for additional information about this field.
Web Service License Type Contact Ephesoft Sales for additional information about this field.
Operating System Identifies the operating system for this installation and license.
License Type

 

 

 

Displays whether this license is Perpetual or Subscription. This setting follows the license model for Release 4.5.0.0, described in the following article:

Note: This information is also available in this article, in the topic titled “Licensing Changes for Ephesoft Transact 4.5.0.x.”

License Version Displays the Ephesoft Transact version for this license.
Additional OCR Language Pack Lists the licensed language packs that are supported by the OCR engines in this installation.
Remaining Number of Images Contact Ephesoft Sales for additional information about this field.
Remaining Hits Per Day Contact Ephesoft Sales for additional information about this field.

Was this article helpful to you?

Vincent Francis