Licensing for Ephesoft Transact 2019.2

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

If you are upgrading to Ephesoft Transact 2019.2 from a previous release, you may be required to obtain a new license file for your environment.

  • Customers on the following versions do not require a new license when upgrading to Ephesoft Transact 2019.2:
    • Ephesoft Transact 4.5.0.0
    • Ephesoft Transact 4.5.0.1
    • Ephesoft Transact 4.5.0.2
    • Ephesoft Transact 2019.1
  • Customers on Ephesoft Transact versions earlier than Ephesoft Transact 4.5.0.0 are required to obtain a new license file.
  • Licensing is based on image count or time, with a start and end date.

Licensing Notes

Ephesoft Cloud HyperExtender Licensing

Ephesoft Release 2019.1 introduced the new Ephesoft Cloud HyperExtender plugin, which enables customers to use cloud-hosted, off-premise processing for certain modules of the Ephesoft Transact workflow.

Licenses for the Ephesoft Cloud HyperExtender plugin have a separate method for activation. The license for the Ephesoft Cloud HyperExtender plugin requires a valid, standard Transact (2019.1 or 2019.2) license, with an additional license for the Cloud HyperExtender plugin.

For additional information, please contact your Ephesoft representative.

Software Release Method Changes

Effective with Release 2019.1, there is no longer a distinction between Major and Minor releases. Each software release is a standalone release, with a direct upgrade path. For example, customers can upgrade directly to an Ephesoft Transact 2019.x release from a 4.5.x.x release. It is not necessary to upgrade to an intermediary, incremental release prior to upgrading to the 2019.x release.

The following snapshot illustrates a licensing example in which Release 2019.2 is installed with a valid Release 2019.1 license.

Note the following aspects of this licensing:

  • This screen is only available to Administrator operators. Navigate to System Configuration > Application > License Details after logging into Ephesoft Transact as Administrator.
  • Application Version field illustrates a valid upgrade to Release 2019.2 from Release 4.5.0.0. The License version is Release 4.5.0.0.
  • License expiry date defines the term of the license, not the software release.

Figure 1: License Details

Additional Licensing Dynamics in Ephesoft Transact 2019.2

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

  • 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:

What languages does Ephesoft Transact support?

Ephesoft Advanced Reporting — Advanced Reporting requires the basic Ephesoft Transact license with an additional license. Advanced reporting is not enabled by default on a cloud-hosted environment, regardless of the purchased licenses.

Licensing Topology for Ephesoft Transact 2019.2

Core Licensing — Ephesoft Transact 2019.2 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 fail-over servers and a 60-core cluster. In this configuration, the number of system cores matches the number of cores on the license.

Figure 2: 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.

Figure 3: Incorrect License Setup in a Multi-server Environment

The following resource provides additional information:

How to Set Up the Ephesoft License Server

Licensing Prerequisites

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

Request the Transact 2019.2 License

To configure, launch and license Transact 2019.2, follow these steps:

1. Install or upgrade Ephesoft Transact 2019.2, 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 2019.2.

Note: To determine the number of “cores” on your system, verify the number of logical processors or cores per socket.
The method differs according to 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.

    • For Windows, obtain the number of logical processors from the following location:
      • Right click in the Windows Task bar or Start menu.
      • Click Task Manager > More Details.
      • Click Performance > CPU.
      • View the Logical processors.

Figure 4: Viewing Logical processors in Task Manager

Linux — Licensing for Linux observes cores per socket.

    • 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.

Figure 5: 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.

Figure 6: Viewing Core(s) in Linux with the nproc Command

Retrieve and Prepare the details.properties File

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

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

{Installation Folder}\Dependencies\licensing

Figure 7: Ephesoft Transact 2019.2 Installation Folder

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

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

a. Add each MAC address for this system to the details.properties file, as required.

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

license pipe

Figure 8: MAC Address Format

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 details.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 command.

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:
        • As the root user (or user with appropriate permissions), type ifconfig -a.
        • From the displayed information, find eth0 — this is the default first Ethernet adapter.
        • Locate the number next to the HWaddr. This is the MAC address.
        • Paste the MAC address or addresses into the details.properties file.
        • Save the changes in the properties file.

5. Send the details.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.

6. Once you have received the license from Ephesoft, install the license. Refer to one of the following procedures, according to your license installation type:

Licensing Ephesoft Transact 2019.2 on Windows

This section contains the following topics for licensing Ephesoft Transact on Windows:

  • Install License on Ephesoft Transact — Windows Fresh Installation
  • Install License on Ephesoft Transact 2019.2 — Windows Upgrade
  • Start Ephesoft Transact 2019.2 on Windows
  • Resolve License Installation Issues on Windows

Install License on Ephesoft Transact — Windows Fresh Installation

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

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 that is compatible with Transact 2019.2. Complete the steps in Requesting the Transact 2019.2 License.

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

HKEY_LOCAL_MACHINESOFTWAREJavaSoftPrefscomephesoft

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 ephesoft.lic file to the EphesoftDependencieslicense-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 ephesoft.system.info and license with data included in them in this registry path:

HKEY_LOCAL_MACHINESOFTWAREJavaSoftPrefscomephesoftlicensecoreannotation

7. To troubleshoot issues that you may observe after completing the above steps, refer to Resolving License Installation Issues on Windows.

Install License on Ephesoft Transact 2019.2 — Windows Upgrade

Perform the following steps to install the license file for an upgrade to Ephesoft Transact on Windows.

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 — ephesoft.lic — that is compatible with Transact 2019.2. Complete the steps in Requesting the Transact 2019.2 License.

2. Copy the new ephesoft.lic file to the EphesoftDependencieslicense-util folder.

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 — ephesoft.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 EphesoftDependencieslicense-util folder.

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.

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

HKEY_LOCAL_MACHINESOFTWAREJavaSoftPrefscomephesoftlicensecoreannotation

5. To resolve issues that could arise from certain additional settings, refer to Resolving License Installation Issues on Windows.

Start Ephesoft Transact 2019.2 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.

Figure 9: Ephesoft Transact Home Menu

2. Select Administrator or Operator to log in.

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

Figure 10: Administrator and Operator Menus

3. Enter the Username and Password.

Figure 11: Login Dialog

This takes you to the login screen.

4. Enter the login credentials:

    • Username — enter ephesoft
    • Password — enter demo

Resolve License Installation Issues on Windows

If you observe issues with Ephesoft Transact after completing the above steps, please refer to the following articles for more information about some of the common issues that may occur during license installation.

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 article for information about how to obtain these log files.

How to Collect the Ephesoft Application Logs

License Ephesoft Transact 2019.2 on Linux

This section contains the following topics for licensing Ephesoft Transact on Linux:

  • Install License on Ephesoft Transact — Linux Fresh Installation or Upgrade
  • Start Ephesoft Transact 2019.2 on Linux
  • Resolve License Installation Issues on Linux

Install License on Ephesoft Transact — Linux Fresh Installation or Upgrade

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: Installing Ephesoft Transact 2019.2 – Single-server – Linux – Fresh Installation
Platform Support: Platform Configuration and Third-Party Integrations – Ephesoft Transact 2019.2
RHEL without a desktop environment: Install Ephesoft Transact on RHEL (headless)
Multiserver installation: Ephesoft Linux Multi-Server Installation guide

2. If necessary, request and obtain a new license file that is compatible with Transact 2019.2. Refer to the following instructions:

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 file.

Figure 12: Folder /opt/Ephesoft/Dependencies/license-util/ephesoft-license-installer

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

./install-license.sh

Figure 13: Running the ./install-license.sh Command

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

./install-license.sh

Step4a

Figure 14: 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.

Start Ephesoft Transact 2019.2 for the First Time on Linux

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

1. 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.

Figure 15: 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.

Figure 16: Home Menu for Ephesoft Transact

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

Figure 17: Administrator and Operator Screens

4. Select a screen and the system displays the login prompt. This takes you to the login screen. Enter the login credentials:

  • Username — enter ephesoft
  • Password — enter demo

Figure 18: Login Dialog

Resolve 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.

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.

View the License Details Screen in Ephesoft Transact 2019.2

Perform these steps to access and display the License Details screen in Ephesoft Transact 2019.2:

1. Log in to Ephesoft Transact with super-admin privileges.

2. Expand the navigation pane on the left and click System Configuration.

 

 

Figure 19: Select System Configuration

The Application folders display.

3. Click License Details to display the contents and settings of the current license, once it has been installed.

Figure 20: Viewing License Details Screen

The following table describes the contents of the License Details screen:

Field or Switch Description
Application Version Contains the software version to which this license currently applies. This field might contain a software version that is later (more recent) than the original software version when the license was purchased.
License Version Contains the software version for which this license applied when first purchased.
License Expiry Date Contains the date on which this Ephesoft Transact license expires.
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.
License-Controlled Batch Class Displays whether there is one or more licensed batch classes for this 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 License Type Contact Ephesoft Sales for additional information about this field.
Web Service Hits Per Day Contact Ephesoft Sales for additional information about this field.
Additional OCR Language Pack Lists the licensed language packs that are supported by the OCR engines in this installation.
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
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.
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.
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
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.
Operating System Identifies the operating system for this installation and license.