Upgrade to Ephesoft Transact 2019.2 – Single-server – Microsoft® Windows

Introduction

This document describes how to upgrade to Ephesoft Transact Version 2019.2 in the following environment:

  • Environment — Single-server
  • Operating System — Windows®

Note: Ephesoft Transact releases prior to Ephesoft Transact 4.1.0.0 are not supported for direct upgrade to version 2019.2.

Supported Windows Versions for Ephesoft Transact 2019.2

Ephesoft Transact 2019.2 supports the following Windows versions for fresh installation, silent installation, or upgrade:

  • Windows 10
  • Windows Server 2012
  • Windows Server 2012 R2
  • Windows Server 2016

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

Restrictions when Upgrading to Ephesoft Transact 2019.2

  • Ephesoft Transact Version 4.5.0.0 or a later 4.5.x.x version is required for upgrade to Ephesoft Transact 2019.2. If you are running an Ephesoft Transact version that is prior to version 4.5.0.0, you must first upgrade to Transact 4.5.0.0 prior to upgrading to Transact 2019.2.

Note: Ephesoft Transact versions prior to Transact 4.1.0.0 are not supported for an upgrade to Transact 4.5.0.0 or 2019.2.

  • New for Ephesoft Transact 2019.2, the Install Wizard does not install MariaDB as a part of the upgrade process. In Ephesoft Transact 2019.2, the Install Wizard allows you integrate an existing MariaDB server during installation of Ephesoft Transact. The MariaDB database must be configured prior to running the Install Wizard.
  • Customers who have a MariaDB version older than version 10.2.1 must upgrade their MariaDB version to version 10.3.8 or later, install or upgrade to Ephesoft Transact Release 2019.2, then import existing batch classes. For the latest information about MariaDB and MySQL version support and installation, refer to the following document:

Install and Migrate MariaDB or MySQL for Windows

  • Microsoft® SQL Server 2008 R2 is not supported in Ephesoft Transact Version 2019.2.
  • MySQL 5.5. is not included with the Ephesoft Transact Version 2019.2 Install Wizard.
  • For the latest information about Ephesoft Transact software support and end-of-life advisories, refer to the following resource:

Ephesoft Transact Release Support

Upgrade Overview

Upgrade to Ephesoft Transact 2019.2 follows this general sequence of tasks.

Installation Task General Scope of Activity
1. Complete the Prerequisite Checks Prepare for upgrade by gathering the required resources and confirming that version 2019.2 supports the target environment.
2. Perform the Upgrade to Ephesoft Transact 2019.2 Launch the 2019.2 Install Wizard with the Windows Command Prompt.
3. Complete the Install Wizard Complete all settings, dialogs and instructions.

1. Complete the Prerequisites Checks

Prerequisites for Upgrade to Ephesoft Transact 2019.2

Review the prerequisites and licensing requirements for your version of Ephesoft Transact prior to beginning the upgrade. Refer to the following additional resources for more information:

Licensing Ephesoft Transact 2019.2

Note: To use CJKT languages in OCR, or to use the subscription license, you must obtain a license from the new Ephesoft Transact license generation process.

To successfully launch and complete the Ephesoft Transact 2019.2 upgrade installer, verify that the following prerequisites are available:

Note: Some prerequisites may have been installed with an earlier version of Transact. If performing a silent installation, it is important to ensure all prerequisites are installed. Otherwise, the installer produces third-party item prompts with their own licenses.

1. Microsoft Visual C++ 2010 Redistributable — Download or Download SP1

2. Microsoft Visual C++ 2012 Redistributable — Download or Download Update 4

3. Microsoft Visual C++ 2013 Redistributable (x86 version) — Download

4. Microsoft Hotfix KB2919355 — Download

5. Microsoft Visual C++ 2015 Redistributable (x64 version) — Download

6. Microsoft Visual C++ 2015 Redistributable (x86 version) — Download

7. Microsoft .NET Framework 4.5.2 — Download

8. Microsoft® Windows OS should be updated to the latest version — Download options

9. Microsoft® SQL Server® 2012 Native Client – QFE* (Version 11.4.7001.0) — Download

10. Microsoft® ODBC Driver 13.1 for SQL Server® – Windows, Linux, & macOS (Version 13.1.4413.46) — Download

11. Microsoft® Command Line Utilities 13.1 for SQL Server® – Windows, Linux, & macOS (Version 13.811.168) — Download

Considerations for Upgrade in a Multi-server Environment

Perform these additional steps for upgrading a multi-server environment:

Note: The installer must be executed on all servers.

1. The Execute database batch checkbox should only be enabled in cases where you are performing upgrade on the first server in the cluster.

2. Start the Ephesoft Transact service. The post-upgrade process initiates. The installation time depends on the number of batch classes and instances.

3. The installer must be executed on the remaining servers and the user must disable the Execute database patch checkbox in a later step.

Prepare for Upgrade in a Single-server or Multi-server Environment

Perform these steps to prepare for upgrade to Transact 2019.2:

1. Close Ephesoft Transact if it is running and stop Transact services before performing the upgrade.

2. Any file and folder inside existing Ephesoft install directory (the path where the previous installation exists), such as the dcma-all.log and other such files and folders, must be closed before upgrade.

3. Ensure that the target Windows installation drive has sufficient space for extraction of the installer setup file.

4. Important — Ephesoft strongly recommends that you back up your Ephesoft and report databases and shared folders. Refer to the following document for more information:

Backing up Ephesoft Transact

2. Perform the Upgrade to Ephesoft Transact 2019.2

After verifying that all prerequisite conditions are met, complete these steps to upgrade to Ephesoft Transact 2019.2:

1. Download the Ephesoft Transact 2019.2 Install Wizard as instructed by Ephesoft. This is a zipped file with the following filename:

WINDOWS_Ephesoft_Transact_2019.2_xxx

where xxx is an Ephesoft build number. This number may be subject to change.

2. Store this file and extract it to a location that is easy to find.

Note: The new upgrade package is a ZIP file. You must extract all files prior to running the installer.

Figure 1: Sample location of the installer zip file

Figure 2: Sample extraction dialog

The following snapshot illustrates the contents of the extracted installer package:

Figure 3: Installer package contents

3. Launch the Windows Administrator Command Prompt app.

  • From the Windows Start menu, search with “cmd” or “command prompt.” The Command Prompt Desktop app returns.

Figure 4: Access Command Prompt in Windows

  • Right click the Command Prompt, then click Run as administrator.

Figure 5: Click Run as administrator

The Administrator Command Prompt windows appears:

Figure 6: Administrator: Command Prompt

4. Execute the following command from the location in which you extracted the .msi file:

C:\>msiexec.exe /i C:\Ephesoft_2019.2.msi

Note that this command cites a sample path to Ephesoft installer setup file. Your location may differ.

Figure 7: Using the msiexec.exe /i C:\Ephesoft_2019.2.msi command

The following screen is displayed.

Figure 8: Security Warning

5. Click Run and initiate the Ephesoft Install Wizard.

Continue to the next procedure.

3. Complete the Install Wizard

Once you have completed the previous procedure, the Install Wizard Welcome screen appears:

Figure 9: Install Wizard Welcome screen

1. Follow the dialogs as instructed to complete the Install Wizard. Click Next to start.

The End-User License Agreement is displayed.

Figure 10: End-User License Agreement

2. Read the terms of the license agreement and click Next to continue. The Install Wizard displays the Ephesoft Prerequisites Check.

Figure 11: Ephesoft Prerequisites Check screen

Transact performs this check, and displays a warning if there is a possible issue. If a warning appears, click Details for more information.

The most important check is to ensure that UAC is disabled. Please verify this parameter before continuing with the upgrade.

3. Click Next when the prerequisites check is acceptable for this installation.

.NET Framework 4.5.2 Installation

Transact performs a check to verify that the .NET Framework 4.5.2 is installed.

Figure 12: .NET Framework 4.5.2 Installation screen

Be aware of the following factors that enable or disable the Next button.

    • If the .NET Framework 4.5.2 is installed on the system, the Next button is enabled.
    • If .NET Framework 4.5.2 is not installed on the system, the Next button is disabled.
      • A Download button appears. Click Download to navigate to the appropriate web link to download the .NET Framework.
      • Download, install .NET, then re-launch the Transact Install Wizard and return to this step.
      • Continue with the installation once the .NET Framework 4.5.2 has been successfully detected by the Install Wizard.

4. Click Next to continue. Transact performs a check of Microsoft® Visual C++ Redistributables.

Figure 13: Ephesoft Prerequisites Installation screen

Note: The Install Wizard may display a temporary message at the bottom:

Transact prerequisites are being installed in the background.

Important: Allow time for the background configuration processes to complete.

5. Wait for the Setup Successful message and click Close.

Define Logon Settings

6. Click Next when prerequisites are verified. The Install Wizard prompts you for account selection and log on credentials.

Figure 14: Log On credentials and account selection

In most cases, users select Local System Account. To create a new account for this Ephesoft Transact installation:

    • Select This Account.
    • Enter the Username and Password.

7. Click Next to complete these settings.

The next dialog prompts you to review database changes.

Enable or disable the Apply database changes setting according to your requirements.

Figure 15: Ephesoft Upgrade Installation dialog for database changes

For a single-server Ephesoft application, this checkbox must be enabled before clicking the Next button.

Important: For a multi-server installation, only perform this update on the first node when upgrading servers that are part of a multi-server environment.

Uncheck (disable) this setting if you are upgrading an Ephesoft Transact installation in a multi-server environment and the database patch has already been executed on a common database by another Ephesoft installation. The database patch is not executed if this checkbox is disabled before clicking Next.

Note: If the setting is checked (enabled) before clicking Next, the database patch is executed after a successful upgrade and the user starts the Ephesoft server.

The Database Backup screen appears.

Figure 16: Database Backup screen

8. Indicate whether you have backed up the database, and click Next.

A message similar to the following screen appears if there are files or folders that are in use or if the setup does not have enough administrative privileges.

Figure 17: Setup dialog to close open files/folders

    • If there is an issue with administrative privileges, close all of those files and folders and re-run the installer setup with administrative privileges.
    • If there is an issue with insufficient disk space, please ensure that more than 7GB of disk space is available. Click Cancel and then re-run the installer setup after sufficient free disk space is available for upgrade.

Figure 18: Disk space warning dialog

If you receive no warnings, the installer is ready to perform the upgrade.

Figure 19: Ready to Install dialog

9. Click Install and the Install Wizard performs the upgrade.

Once the Install Wizard has completed the installation, it provides Post-Installation Instructions. Read these instructions carefully to be aware of License tasks that must follow after installation.

Figure 20: Post-Installation and License Information

10. After reading the license requirements, click Next. The following screen appears to confirm that installation is complete.

Figure 21: Ephesoft Transact 2019.2 Setup is Complete

You have the option to restart the system once you close the Install Wizard.

NOTE: Ephesoft recommends restarting the system after finishing the upgrade.

11. Click Finish to complete this step of the upgrade. Upon reboot, start the Ephesoft Transact service (from the Windows Control Panel). This initiates the post-upgrade process.

Figure 22: General tab for Ephesoft Transact Properties

Note: The post-upgrade process requires some time, based on the number of batch classes and instances. Once the post-upgrade is complete, the application is available.

The Ephesoft Transact 2019.2 home page appears.

Note: Allow time for the background configuration processes to complete.
The initial startup may require a few minutes to launch.

Figure 23: Ephesoft Transact home screen

12. Select Administrator or Operator to log in.

13. Enter the Username and Password.

Figure 24: Login Screen

Important: Allow time for the background configuration processes to complete.
The initial startup may require a few minutes to launch.

Conclusion

Upon successful completion of this document, you have upgraded to Ephesoft Transact 2019.2 on a Windows server.

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