Installing Ephesoft Transact 2019.1 – Single-server – Microsoft® Windows – Fresh Installation

Introduction

Overview

This document provides information about installing Ephesoft Transact Version 2019.1 in the following environment:

  • Environment — Single-server
  • Operating System — Microsoft Windows®
  • Installation type — Fresh

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

  • Windows 7 SP1
  • Windows 10
  • Windows Server 2012
  • Windows Server 2012 R2
  • Windows Server 2016

IMPORTANT: This document has been updated to describe how to install the Ephesoft Transact 2019.1 Hotfix.
For additional information about this Hotfix, refer to the following article:

NOTE: Ephesoft Transact releases prior to Ephesoft Transact 4.1.0.0 are not supported for direct upgrade to version 2019.1.

Additional Information for Transact 2019.1

The following resources describe additional preparation or requirements for Ephesoft Transact 2019.1:

Installation Overview

The installation of Ephesoft Transact 2019.1, as described in this document, follows this general sequence of tasks.

Installation Task General Scope of Activity
1. Complete the Prerequisite Checks Prepare for installation by gathering installation resources and verifying that the environment is supported.
2. Launch the Install Wizard Launch the 2019.1 Install Wizard with the Windows Command Prompt.
3. Complete the Install Wizard Complete all settings and screens as prompted.
4. Complete the Ephesoft Transact Hotfix Installation Complete all instructions as provided.
5. License and Launch Ephesoft Transact 2019.1 License and launch Ephesoft Transact, then log in.

Upon completion of this task, all authorized Administrators and Operators can log in for operations.

1. Complete the Prerequisites Check

Summary

The prerequisites for installation include the following:

  • License requirements
  • Operating system requirements
  • Database support parameters for this software release
  • Basic Windows preparation
  • Install Wizard package download

Procedure

Perform these steps to complete all prerequisite conditions for a successful installation.

NOTE: Upon completion of this task, the admin user should be prepared to complete all remaining tasks in this document.

1. Contact your Ephesoft representative or Professional Services Engineer for information about accessing the Installer Package (Install Wizard) and license, as required.

2. Verify that you have a license for Ephesoft Transact 4.5.x.x or later. This is required for launching Ephesoft Transact 2019.1 once the installation is complete.

3. Verify that the operating system and database environment each support Transact 2019.1:

4. Obtain the database type and connection settings for this installation. This confidential information is available from the network administrator within your organization.

  • Username and Password
  • Database connection parameters

5. Obtain or define the Transact Shared Folder location.

  • This document supports setting up the Shared Folder as a part of the local installation or using Shared Folder on the network.

6. Log onto the Windows system on which Ephesoft Transact is to be installed, and perform the following tasks to prepare Windows for installation:

a. Disable (turn off) the user access control (UAC).

  • From the Windows Start menu, search for User Access Control or UAC. Windows displays the link for this page from the Control Panel. Click this link to display the page.
Change User Account Control settings

The User Account Control Settings screen appears.

User Account Control Settings screen
  • In many cases, the initial settings may be on higher levels of security (toward the Always notify side of the scale). Adjust this setting to the bottom-most position (Never notify), as shown in the above illustration.

The system prompts the user to confirm this setting. Accept the changes.

b. Disable the IPv6 network protocol.

  • This control is available in the Windows Network Settings. There are multiple ways to navigate to network settings, such as the following:
    • Navigate to Control Panel > Network and Internet > Ethernet.
    • In the Windows toolbar on the desktop, right click the Network icon, and click Open Network & Internet Settings > Ethernet.
    • From the Ethernet screen, click Change adapter options. A new screen opens that displays one or more networks.
Network Connections example
  • Right click the network on which to disable IPv6, and click Properties from the popup menu.
Click Properties to change IPv6 settings

The Ethernet Properties screen appears.

Ethernet Properties settings
  • Scroll down to the Internet Protocol Version 6 (TCP/IPv6) setting, and ensure that it is unselected or disabled.
Disable the Internet Protocol Version 6 (TCP/IPv6) setting
  • Click OK to save changes. The system returns you to the Ethernet page of Control Panel.
  • Exit out of the Windows Control Panel.

c. Be aware that the Install Wizard will check the environment variables for Windows.

NOTE: The environment variables are an automated part of running the Ephesoft Install Wizard. This item is cited here for user awareness.

Please continue to the next procedure.

2. Obtain and Launch the Install Wizard Package

Once you have completed the prerequisites, as described in the previous procedure, you are ready to obtain and launch the Installer package, also known as the Install Wizard.

Summary

This task entails the following general steps:

  • Obtain the downloadable Install Wizard package
  • Launch the Windows Command Prompt to launch the Install Wizard

Procedure

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

NOTE: Upon completion of this task, the admin user should view the Install Wizard Welcome screen.

1. If you have not already done so, please contact your Ephesoft partner, sales representative, or Professional Services engineer for the Installer package (Install Wizard Package) and license.

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

WINDOWS_Ephesoft_Transact_2019.1_448

3. Store this file and extract it to a location that is easy to find. You will navigate to this location with the Windows Command Prompt in the next steps.

The following snapshot illustrates one such location.

NOTE: The license file is also stored in this temporary location for illustration.

Sample download location for the Install Wizard package

Once you extract the zipped Install Wizard package, you can view the contents of the Install Wizard by opening the Transact2019 folder, as shown below:

Contents of the extracted Install Wizard package

NOTE: It is the Ephesoft 2019.1 executable batch file to launch from the Windows Command Prompts in the upcoming steps.

4. Launch the Windows Administrator Command Prompt.

  • From the Windows Start menu, search with “cmd” or “command prompt.”
    The Command Prompt Desktop app appears as a match.
Access Command Prompt in Windows
  • Right click the Command Prompt.
  • From the popup menu, click Run as administrator.
Click Run as administrator

The Administrator Command Prompt windows appears, as illustrated in the following snapshot:

Administrator: Command Prompt

5. Execute the following commands in sequence to navigate to the location of the Install Wizard file. The following commands illustrate navigation to the location of the Install Wizard file, but your destination directory may differ:

  • C:\Windows\system32>cd..

The above command navigates to the higher directory.

  • C:\Windows\>cd..

The above command navigates to the root directory.

  • C:\cd transact2019
    C:\Transact2019>

The above command navigates to the directory that contains the Install Wizard file.

Note: For illustration, this set of commands navigates to a sample directory (Transact2019) from root.

If necessary, use the cd command to navigate to the application directory you intend to use for the installation of Ephesoft Transact.

6. From the Transact application directory for your installation, execute the following command to launch the Install Wizard file.

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

NOTE: If you receive the following error message, ensure that you have executed the above command from the correct directory with complete command syntax:

Error message that may appear

The Install Wizard displays the Welcome screen.

Please continue to the next procedure.

3. Complete the Install Wizard

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

Install Wizard Welcome screen

Summary

Follow all dialogs as instructed by the Install Wizard.

  • Licensing information
  • User setup
  • Database setup
  • Additional parameters as prompted

Procedure

Perform the following steps to complete each screen in the Install Wizard:

1. Click Next on the Welcome screen. The End-User License Agreement is displayed.

License Agreement screen

2. Read the terms of the license agreement and click Next to continue. The Ephesoft Prerequisites Check is displayed.

Ephesoft Prerequisites Check screen

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

3. Click Next when the prerequisite check is acceptable.

.NET Framework 4.5.1 Installation

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

.NET Framework 4.5.1 Installation screen
  • • If the .NET Framework 4.5.1 is installed on the system, the Next button is enabled.
  • • If .NET Framework 4.5.1 is not installed on the system, the Next button is disabled.
    • Instead, a Download button appears. Click the Download button 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.1 has been successfully detected by the Install Wizard.

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

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. Click Next when prerequisites are verified. The Install Wizard prompts you for account selection and log on credentials. In most cases, users select Local System Account.

Log On credentials and account selection
  • • To create a new account for this Ephesoft Transact installation:
    • Select This Account.
    • Enter the Username and Password.

6. Click Next to complete these settings. The database configurations appear.

Select and Set Up the Database

7. Select the database to install or configure. Click Next.

Install/Configure Database screen

NOTE: The sequence of screens differs for each database option. Select one of the database options, and click Next.

8. Follow the onscreen instructions for the appropriate database:

A. MariaDB Configuration

Follow these steps when setting up a Maria DB database during the installation of Ephesoft Transact. There are two options for the MariaDB Server setup:

  • Install a new instance
  • Configure an existing instance
Selecting Install a new MariaDB Instance
  • Select one option for MariaDB and click Next.
  • If installing a new MariaDB instance, the following screen appears. Enter the information as prompted.
Entering Database Information
  • If configuring an existing MariaDB instance, enter the database details. The following snapshot illustrates a MariaDB Server Configuration:
Database Configuration Information
  • Once you have provided MariaDB server configuration, click Next. The Install Wizard displays the Database Login Configuration dialog.
Database Login Configuration
  • Enter the login credentials for MariaDB. Enter the root password and confirm. Leave the default settings.
  • Click Next to complete this MariaDB database setup. The MariaDB database configuration for this installation of Ephesoft Transact is now complete.

Navigate to the following section to configure Open Office and continue with the Install Wizard:

B. Microsoft SQL Server Configuration

Follow these steps when setting up a Microsoft SQL Server database during the installation of Ephesoft Transact.

  • Select Microsoft SQL Server on the Install/Configure Database screen, as illustrated below.
Microsoft SQL Server
  • The Install Wizard prompts you for integration information, as illustrated in the following snapshot. Select any additional options, as needed for this installation.

NOTE: Microsoft SQL Server 2012 or later is required for integration with Ephesoft Transact 2019.1.

Selecting the installation type for Microsoft SQL Server
  • The Install Wizard does not support the installation of a new instance of MS SQL Server. The only option is to configure an existing MS SQL instance, as illustrated in the following steps.
  • You may wish to refer to the following article for additional information about MS SQL Server setup:
    • Prerequisites | Configuring Named Instance for Microsoft® SQL Server Prior to Installing Transact 2019.1

https://ephesoft.com/docs/2019-1/installing-upgrading/install-upgrade-single-server/installing-on-windows/prerequisites-windows-install/

  • If selecting Configure existing Microsoft SQL instance, without Windows authentication, the following screen appears:
Local/Remote Microsoft SQL Server Configuration, without Windows Authentication
  • Enter the information into the Database Login Configuration screen, as illustrated below:
Database Login Configuration for an existing Microsoft SQL Server
  • If using Windows authentication, enter the following information, as illustrated:
Microsoft SQL Server Configuration, with Windows Authentication
  • Click Next to complete this database setup. The MS SQL Server database configuration for this installation of Ephesoft Transact is now complete.

Navigate to the following section to configure Open Office and continue with the Install Wizard:

C. Oracle Database Configuration

Follow these steps when setting up an Oracle database during the installation of Ephesoft Transact.

  • Select Oracle Database Server in the Install/Configure Database screen, as illustrated below:
Select Oracle Database Server
  • The Local/Remote Oracle Server Configuration Information screen appears, with option to create new schema or configure existing schema. With either of the following two options, an SID is required.
Oracle server configuration Task
  • First Option: Select the first option to create new Oracle schema. The following screen appears:
Local/Remote Oracle Server Configuration — Create New Oracle Schema

— Enter the appropriate information in the text fields and click Next.

  • Second Option: Select the second option to use existing Oracle schema. The following screen appears:
Local/Remote Oracle Server Configuration

— Enter the appropriate information in the text fields for the Oracle database.

  • Click Next to finish this database setup. The Oracle database configuration for this installation of Ephesoft Transact is now complete.

Navigate to the following topic to configure Open Office and continue with the Install Wizard.

Configure Open Office

After completing database setup in one of the previous three sections, the Open Office screen appears.

Open Office Configuration

9. Use the default port number, unless the network requires a different port. Click Next to proceed.

Configure Authentication Mode

The Authentication Mode dialog appears, as illustrated below:

Choose an Authentication Mode

10. Select the appropriate Authentication Mode for this installation of Ephesoft Transact.

a. If selecting Standard Form Authentication, choose HTTP or HTTPS. HTTP is the default selection. Note that HTTPS is a more secure connection.

— Click Next. The following screen appears.

SSL (Secure Socket Layer) Certificate Details

— Provide the certificate file, password and port number for HTTPs configuration.

— Click Next to complete this configuration for authentication. Proceed to Configure User Connectivity Settings.

b. If selecting PKI Authentication, the Install Wizard gives you the option to browse to the property file, as illustrated below:

PKI Authentication and optional Property File

— Click Next to continue with PKI configuration The Certificate Details for PKI screen appears:

Certificate Details for PKI

— Enter the appropriate information in the text fields and click Next. The Realm Settings for PKI screen appears.

Realm Settings for PKI

— Enter the appropriate information in the text fields and click Next. The Connector Settings for PKI screen appears.

Connector Settings for PKI

— Enter the appropriate information in the text fields.

— Click Next to complete this configuration for authentication. Proceed to Configure User Connectivity Settings.

Configure User Connectivity Settings

Once you have configured authentication mode and the related screens, the Install Wizard displays the User Connectivity Settings, as illustrated below:

User Connectivity Settings

NOTE: The default selection is Tomcat, which works with the Apache server.

11. Define the User Connectivity Settings as prompted for (a) LDAP, (b) Active Directory or (c) Tomcat.

a. LDAP — The following snapshot illustrates User Connectivity Setting for LDAP configuration. If this applies to the installation, enter the appropriate information in the text fields and click Next.

LDAP Configuration for User Connectivity Settings

b. Active Directory — The following snapshot illustrates User Connectivity Settings for Active Directory configuration. If this applies to the installation, enter the appropriate information in the text fields and click Next.

Active Directory configuration for User Connectivity Settings

c. Tomcat — The following snapshot illustrates the first screen of User Connectivity Settings for Tomcat. If this applies to the installation, click Next.

User Connectivity Settings for Tomcat – first screen

Enter Ephesoft Registration, Shared Folder and Installation Information

Once you have completed User Connectivity Settings with the previous step, the Ephesoft Registration Information screen appears.

Ephesoft Registration Information screen

12. Enter the appropriate information in the text fields and click Next. The Shared Folder Configuration screen appears.

Shared Folder Configuration screen

— Select No — If this is the first Windows system on which installing Ephesoft Transact, select No, to indicate that there is not already a Shared Folder. Select No if you are not creating a multi-server environment or do not have an existing folder. The Install Wizard will install a Shared Folder along with Transact 2019.1.

— Select Yes — If this is a multi-server environment.

NOTE: If this is a multi-server environment, Ephesoft provides additional resources specifically for those configurations. Please use the following resources:

Install & Upgrade — Multi-Server

13. Click Next. The Installation Folder screen appears.

Installation Folder setup screen

The default installation location is commonly used, but change the location as needed.

If there is a Shared Folder elsewhere on the network, and you wish to use that Shared Folder for this installation, select Install Shared folder separately, and define the network location.

14. Click Next in the Installation Folder screen.

Run and Finish the Install Wizard

The Ready to Install screen appears once you have completed the Installation Folder screen and all previous steps in this procedure.

NOTE: You have the option to navigate back to any previous screen to review or adjust any configuration.

Ready to Install screen

15. Click Install to launch the installation process. A Status bar displays progress of the installation.

Status bar of the Install Wizard progress

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.

Post-Installation and License Information

16. Click Next. The following screen appears to confirm that installation is complete.

Ephesoft Transact 2019.1 Setup is Complete

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

NOTE: Ephesoft recommends installing the Hotfix prior to restart.

17. Click Finish to complete the installation, without restarting the computer.

4. Complete the Ephesoft Transact Hotfix Installation

After the initial release on January 31, 2019, Ephesoft discovered certain critical issues that impacted performance and reliability in Ephesoft Transact 2019.1.

Ephesoft created a Hotfix to address these issues. This Hotfix must be installed immediately after you complete the Install Wizard, as described in the previous section.

Please note that installation of Ephesoft Transact 2019.1 requires that you restart your computer to complete the process. To save time, you can install the Hotfix immediately after completing the Install Wizard, and then restart your computer.

Perform the following steps to install the Hotfix for Ephesoft Transact 2019.1:

1. Stop the Ephesoft Transact service.

a. In the Windows start menu, or the Windows Control Panel, search for Services | Desktop App.

b. Right click the Services utility and run as administrator. The Services (Local) screen appears. Scroll down to EphesoftTransact.

Sample illustration of the Windows Services utility

c. If the EphesoftTransact service is running, right click EphesoftTransact, and click Stop. The status will display nothing, as the service is no longer running.

d. Close the Windows Service Control utility.

2. Obtain the Hotfix, HOTFIX_2019.1_Generic_04_Apr_2019.zip, and copy this file to a temporary location. Extract all contents of this file.

This Hotfix is available for download from the following location:

http://download.ephesoft.com/Ephesoft_Product/2019.1/Hotfix/2019.1_Fix_Pack.zip

3. Copy the following extracted JAR files:

  • • dcma-batch-*
  • • dcma-util-*
  • • dcma-recostar-*
  • • gxt-core-*
  • • gxt-review-validate-*

Copy these JAR files to the following directory:

{Ephesoft-installation-directory}\Application\WEB-INF\lib\HOT-FIXES

4. Back up the existing reviewValidate and bm folders in the following directory:

{Ephesoft-installation-directory}\Application\

5. Copy the extracted reviewValidate and bm folders to the following directory:

{Ephesoft-installation-directory}\Application\

6. If you did not restart the computer after running the Install Wizard, as described in
3. Complete the Install Wizard, restart the computer now.

7. Start the Ephesoft Transact service.

a. In the Windows start menu, or the Windows Control Panel, search for Services | Desktop App.

b. Right click the Services utility and run as administrator. The Services (Local) screen appears. Scroll down to EphesoftTransact.

Sample illustration of the Windows Services utility

c. If the EphesoftTransact service is not running, right click EphesoftTransact, and click Start. The service starts with the following progress indicator:

Service Control progress dialog

Upon successful startup of the EphesoftTransact service, the status will display Running.

EphesoftTransact service is running

d. Close the Windows Service Control utility.

5. License and Launch Ephesoft Transact 2019.1

Summary

Licensing and launching Ephesoft Transact after installation must include these general tasks:

  • • Install the Ephesoft license
  • • Enable the Ephesoft Transact service on Windows
  • • Launch the Ephesoft Transact application, to view the home page and log in

Upon completion of this task, any authorized Operator or Administrator user who has the application URL should be able to log in to Ephesoft Transact from the web browser for production operations.

Procedure

Perform these steps to license and launch Ephesoft Transact.

1. Obtain and install the license for Ephesoft Transact with instructions provided in the following document:

The target location of the license file is typically as follows:

— {Ephesoft directory}\Dependencies\license-util\

The following snapshot illustrates the typical location for the license:

Typical Location for Ephesoft Transact License

The following steps provide abbreviated instructions for installing the license. For complete information, refer to the article cited above.

a. Launch the Windows Administrator Command Prompt.

— From the Windows Start menu, search with “cmd” or “command prompt.” The Command Prompt Desktop app appears as a match.

Access Command Prompt in Windows

b. Right click the Command Prompt. From the popup menu, click Run as administrator.

Click Run as administrator

The Administrator Command Prompt windows appears, as illustrated in the following snapshot:

Administrator Command Prompt

c. Navigate to the directory that contains the license file. The following sequential commands illustrate navigation to a sample directory:

C:\Windows\system32>cd..

C:\Windows\>cd..

C:\cd Ephesoft

C:\Ephesoft>cd Dependencies

C:\Ephesoft\Dependencies>cd license-util

C:\Ephesoft\Dependencies\license-util>install-license.bat

Once you have executed the install-license.bat command in the correct directory, the command prompt will display progress and BUILD SUCCESSFUL.

d. Ephesoft highly recommends running this command again to ensure that the license is successfully installed:

C:\Ephesoft\Dependencies\license-util>install-license.bat

The following snapshot illustrates this sequence of commands, from changing directory to executing the batch file:

Command Prompt license installation commands

2. Start the Ephesoft Transact service on this Windows system.

a. In the Windows start menu, or the Windows Control Panel, search for Services | Desktop App.

b. Right click the Services utility and run as administrator. The Services (Local) screen appears. Scroll down to EphesoftTransact.

Sample illustration of the Windows Services utility

c. If the EphesoftTransact service is not running, right click EphesoftTransact, and click Start. The service starts with the following progress indicator:

Service Control progress dialog

Upon successful startup of the EphesoftTransact service, the status will display Running.

EphesoftTransact service is running

d. Close the Windows Service Control utility.

3. Launch Ephesoft Transact. Follow these steps:

a. Launch a Web browser session.

b. Enter the location of the Ephesoft Transact application. The following URL illustrates the typical path when running Ephesoft Transact on the local system:

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

The Ephesoft Transact 2019.1 home page appears.

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

Ephesoft Transact home screen

4. Select Administrator or Operator to log in.

5. Enter the Username and Password.

Login Screen

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

For additional information about using Ephesoft Transact once it is successfully installed, refer to the following resources: