Windows Upgrade Guide 2020.1

Introduction

This document describes how to upgrade to Ephesoft Transact 2020.1 in the following environments:

  • Environment types — single and multi-server
  • Operating System — Windows®

Important: Steps unique to a multi-server upgrade are identified where applicable in this document.

Upgrade Overview

The process of upgrading to Ephesoft Transact 2020.1 follows this general sequence of tasks.

Installation TaskGeneral Scope of Activity
PrerequisitesPrepare for upgrade by gathering the required resources and verifying that the environment and databases are supported.
Prepare the Server for UpgradePerform these steps to prepare the server for the upgrade Install Wizard.
Obtain and Launch the Install Wizard PackageLaunch the 2020.1 Install Wizard with the Windows Command Prompt. Complete all settings and dialogs as prompted
License and Launch Ephesoft Transact 2020.1Perform these steps to complete the upgrade for Ephesoft Transact 2020.1.

Prerequisites

Perform these steps for a successful software upgrade and startup:

  1. Determine if you need to perform a single-server or multi-server upgrade.

Important: Steps unique to a multi-server environment upgrade are identified where applicable throughout this document. Follow the instructions and adjust as necessary if upgrading on a multi-server environment.

  1. Verify that the existing installation of Ephesoft Transact is supported for direct upgrade to Ephesoft Transact 2020.1.
    • If the system is currently running Ephesoft Transact version 4.5.0.0 or above, your system is supported for direct upgrade to Ephesoft Transact 2020.1.
    • If the system is currently running a release prior to Ephesoft Transact 4.5.0.0, you will need to upgrade to version 4.5.0.0 before upgrading to Ephesoft Transact 2020.1.

Important: If you are required to perform an intermediate upgrade, then you must launch the Ephesoft Transact 4.5.0.0 service before upgrading to version 2020.1 or the upgrade process will fail.

    • If you are required to perform an intermediate upgrade, you will need a new license for Ephesoft Transact 4.5.0.0.
  1. Refer to Platform Configuration and Third-Party Integrations 2020.1 and verify that Ephesoft Transact 2020.1 is supported on your operating system.

Important: If you are upgrading to Ephesoft Transact 2020.1 with an existing Ephesoft installed version of MariaDB or MySQL database engine, refer to the following document before proceeding any further with this upgrade: Install and Migrate MariaDB or MySQL for Windows.

User Instructions

Prepare the Server for Upgrade

Perform these steps to prepare the server for an upgrade to Ephesoft Transact 2020.1:

  1. Stop Ephesoft Transact, whether running as an application or service:

a. To stop Ephesoft Transact when running as an application, close the Java Console in which Ephesoft Transact is running (as shown in the screenshot below) with CTRL + C.

Figure 1. Ephesoft Transact Command Prompt

      • Open the Windows Task Manager and click End Task to terminate the following processes, if they were not terminated:
        • soffice.exe
        • soffice.bin

 b. To stop Ephesoft Transact when running as a service, perform these steps:

      • In the Windows Control Panel, browse to Services | Desktop App.
      • Right-click the Services utility and run as administrator. The Services (Local) screen displays. Scroll down to EphesoftTransact.

Figure 2. Sample Illustration of the Windows Services Utility

      • If the EphesoftTransact service is running, right-click EphesoftTransact, and click Stop. The service stops.
      • Close the Windows Service Control utility.
  1. Close all open files inside the existing Ephesoft installation directory.
  2. Ensure that the target Windows installation drive has enough space for extraction of the installer setup file and the backup files that the installer will create. Depending on the size of the existing Ephesoft Transact instance, you may require up to 8GB of space.
  3. Log onto the Windows system and set the User Access Control (UAC) to Never notify.

Important: This is a temporary setting, and you must re-enable UAC after completing the installation later in this document.

    • From the Windows Start menu, browse to the User Access Control or UAC. The Windows Control Panel displays the link. Click this link to display the page.

Figure 3. Change User Account Control settings in Windows Control Panel

The User Account Control Settings screen displays.

Figure 4. User Account Control Settings

a. If the security setting is closer to the Always notify part of the scale, adjust this setting to the lowest position (i.e., Never notify) as shown in figure 4. The system prompts the user to confirm this setting.

b. Accept the changes.

  1. Disable the IPv6 network protocol on this server. This control is available in the Windows network settings.

a. Select Control Panel > Network and Internet > Ethernet.

b. From the Ethernet screen, click Change adapter options. A new screen displays one or more networks.

Figure 5. Network Connections Example

c. Right-click the network on which to disable the IPv6 and click Properties from the pop-up menu.

Figure 6. Click Properties to Change IPv6 Settings

The Ethernet Properties screen displays.

Figure 7. Ethernet Properties Settings

d. Clear the Internet Protocol Version 6 (TCP/IPv6) check box.

Figure 8. Disable the Internet Protocol Version 6 (TCP/IPv6) Setting

e. Click OK to save changes. The system returns you to the Ethernet page. Close the Windows Control Panel.

  1. If you previously installed Ephesoft Transact using a Windows service account and you want to use that same account after the upgrade, ensure you know that account’s credentials (username and password) before starting the upgrade procedure.

You are now ready to obtain and launch the Install Wizard.

Obtain and Launch the Install Wizard Package

Perform these steps to download and launch the Ephesoft Transact Install Wizard:

  1. Contact Ephesoft for access to the Install Wizard package.
  2. Download the Ephesoft Transact 2020.1 Install Wizard as instructed by Ephesoft. This is a zipped file with the following filename: WINDOWS_Ephesoft_Transact_2020.1_1316.zip

Note: The last four digits are an Ephesoft build number that is subject to change.

  1. Extract all contents of the zip file to a temporary location. To extract the file, right-click the file, and from the pop-up menu, click Extract All.

Figure 9. Click Extract All

Important: You must extract all elements of the installer package. The following figure illustrates the contents of the extracted installer package:

Figure 10. Installer Package Contents

  1. Open the Windows Command Prompt as an Administrator. Navigate to the directory where you extracted the installer zip file, then execute the following command to download the Windows installer package: msiexec.exe /i Ephesoft_2020.1.msi
  2. After you download the Windows installer package, the following screens display consecutively.

Figure 11. Computing Space Requirements

  1. The Next button will be enabled if the installer determines there is enough disk space to install the software. You will need approximately 8GB of disk space for the upgrade. If you need to make space available for the upgrade, remove any files and apps that you no longer need.

Figure 12. The Ephesoft Transact 2020.1 Setup Screen

  1. Click Next. The End-User License Agreement displays.

Figure 13. End-User License Agreement

  1. Read the end-user license agreement to be aware of any changes, select the check box to accept the terms, and click Next to continue.

Note: If your Ephesoft Transact environment previously used an instance of MariaDB that was installed inside the Ephesoft Transact installation folder structure, the following screen displays:

Figure 14. Bundled MariaDB Installation Not Supported

  1. If you have already installed a standalone instance of MariaDB and migrated the Ephesoft Transact databases to the new instance, select the check box and click Next.
  2. If you have not performed those tasks, click Cancel to exit the Install Wizard.

Important: You must install or migrate the MariaDB database prior to completing the upgrade Install Wizard for Ephesoft Transact 2020.1 or your Ephesoft Transact databases will be lost. Refer to the following document for additional information: Install and Migrate MariaDB or MySQL for Windows.

The Ephesoft Prerequisites Check displays.

Figure 15. Ephesoft Prerequisites Check

Note: The Install Wizard may take several minutes to perform these prerequisite checks. If a warning displays in the above screen, click Details for more information. The following is an example of this type of message: “JAVA_HOME environment variable is already defined. This will get modified during Transact installation. If you do not want this to happen, please cancel the installation.”

  1. Click Next when the prerequisites check is acceptable. Continue to .NET Framework 4.5.2 Installation.

.NET Framework 4.5.2 Installation

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

Figure 16. .NET Framework 4.5.2 Installation

The following factors enable or disable the Next button:

  • The Next button is enabled if the .NET Framework 4.5.2 is installed on the system.
  • The Next button is disabled if the .NET Framework 4.5.2 is not installed on the system. A Download button will display. Follow these steps:

a. Click Download and go to the appropriate link.

b. Download and install the .NET 4.5.2 Framework.

  • Once you have completed the installation of .NET 4.5.2 Framework, continue to step 12.
  1. Click Next. The Install Wizard performs a check of Microsoft® Visual C++ Redistributables.

Figure 17. Ephesoft Prerequisites Installation

Note: The Install Wizard may display the following message: “Transact prerequisites are being installed in the background.” Allow time for the background configuration processes to complete. Continue to Define Service Credentials.

Define Service Credentials

If you are running the Ephesoft Transact Server as a Windows service, the Install Wizard prompts you to choose which service account to use. It is recommended to use the same Windows account that was used to install your previous version of Ephesoft Transact. Ensure to choose the account that complies with your organization’s security policy.

  1. In most cases, users select Local System Account.
  2. To use another existing account, select This Account

Figure 18. Service Credentials and Account Selection

Note: Use this option with a Windows service account that has access to the SharedFolders component , whether locally or remote. Ephesoft recommends configuring SharedFolders on a network location for future growth and scalability. To proceed, enter the username and password for an account that has full access permissions to the network SharedFolder path.

  1. Click Next. The Ephesoft Upgrade Installation screen displays.

Figure 19. Ephesoft Upgrade Installation Dialog for Database Changes

  1. The following steps vary depending on a single or multi-server upgrade.
    • Check the Apply database changes check box if you are upgrading a single-server environment, or if you are upgrading the first server in a multi-server environment.
    • Do not check the Apply database changes check box if you have already upgraded the first server in your multi-server installation and are now upgrading a subsequent server.
  1. Click Next.
    • The Install Wizard will check if you have enough disk space for the upgrade installation. If your server does not have enough space, the following message may display:

Figure 20. Disk Space Warning

    • If you see this message, click Cancel to exit the Install Wizard. Clear the appropriate amount of disk space and restart the Install Wizard.

The Database Backup screen displays.

Figure 21. Database Backup Screen

  1. Select the check box if you have backed up the database and click Next.

Note: This message displays if Ephesoft Transact files or folders are in use:

Figure 22. Setup Dialog to Close Open Files/Folders

    • If you see this message, close any open files or folders in the Ephesoft Transact installation area, then click OK to return to the previous Install Wizard screen and click Next.
    • If you don’t receive any warnings, the installer is ready to perform the upgrade. Click Next to continue the upgrade.

Run and Finish the Install Wizard

The Ready to Install screen displays after you have completed the database backup.

Note: If needed, click Back to adjust your configurations in previous screens.

  1. Click Install.

Figure 23. Ready to Install Screen

A Status bar displays the installation’s progress.

Figure 24. Status Bar of the Install Wizard Progress

Once the upgrade installation is completed, the Post-Installation Instructions screen displays.

Figure 25. Post-Installation Instructions and License Information

  1. Read the post-installation instructions and perform the necessary tasks, then click Next. The following screen displays to confirm that the installation is complete.

Figure 26. Ephesoft Transact 2020.1 Setup is Complete Screen

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

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

  1. Click Finish.
  2. When the upgrade installation is complete, re-enable User Access Control (UAC) on this server.

Important: This was a temporary setting required when running the Install Wizard in a previous task. This procedure re-activates UAC after installation.

a. From the Windows Start menu, select the User Access Control settings. The Windows Control Panel displays a link. Click this link to display the page.

Figure 27. Change User Account Control settings in Windows Control Panel

The User Account Control Settings screen displays.

Figure 28. User Account Control Settings

b. Adjust this setting to the desired position for normal operations. Your setting may differ from the illustration shown above. The system prompts you to confirm this setting. Accept the changes.

This completes your upgrade. Continue to License and Launch Ephesoft Transact 2020.1.

License and Launch Ephesoft Transact 2020.1

To complete the upgrade, refer to Licensing Requirements.

Important: Ephesoft recommends restarting the service after your license registry is updated.

a. Compare the post-upgrade properties files against the pre-upgrade properties files. You must match the configuration settings of the post-upgrade property files to the pre-upgrade property files.

Note: Prior to installing the upgrade, the upgrade Install Wizard creates a backup folder to store the pre-upgrade configuration settings and components.

      • Use the Winmerge tool to compare and merge the pre-upgrade configurations into the post-upgrade configurations. Original configuration files are backed up on same server. You can navigate to the Ephesoft Install Directory and find the backup folder of your previously installed version of Ephesoft Transact to get access to your old configurations, files, and settings. Properties, files settings, or components that are unique to each deployment can include the following:
        • Computer names
        • Database paths
        • HTTPS settings (as applicable)
        • ImageMagick settings (as applicable)
        • JavaAppServer settings
        • Keystore location settings
        • Registry settings
        • Single Sign-On (SSO) configurations
        • User connectivity settings for Active Directory, Apache Tomcat, or LDAP

Refer to Folders where Customer-specific Data is Stored for additional information.

b. If you are required to perform an intermediate upgrade to 4.5.0.0, your previously installed license will not work on 4.5.0.0. You will need a new license for Ephesoft Transact 4.5.0.0 in order to successfully launch Ephesoft Transact.

  1. Start the Ephesoft Transact service from the Windows Services interface. This initiates the post-upgrade process.

Note: You may choose to change the Startup Type option to Automatic so that Ephesoft Transact will start automatically whenever the server reboots in the future.

//cdn.ephesoft.com/docs/wp-content/uploads/2019/06/word-image-29.png

Figure 29. General tab for Ephesoft Transact Properties

Note: The first startup after the post-upgrade process performs updates to the database, batch classes and other Ephesoft Transact elements.

After starting the Ephesoft Transact service, you are ready to launch Ephesoft Transact. Follow the steps below:

  1. Open a web browser
  2. Enter the following Ephesoft Transact URL: http://<server_name>:8080/dcma/home.html

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

The Ephesoft Transact 2020.1 home page displays.

//cdn.ephesoft.com/docs/wp-content/uploads/2019/06/word-image-30.png

Figure 30. Ephesoft Transact Home Screen

  1. Select Administrator or Operator to log in.
  2. Enter the username and password.

Figure 31. Login Screen

Conclusion

This completes the upgrade process.