Install Ephesoft Transact 2019.2 – Single-server – Microsoft® Windows – Fresh Installation

Introduction

Document Overview

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

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

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

Installation Overview

The installation of Ephesoft Transact 2019.2 entails 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.2 Install Wizard with the Windows Command Prompt.
3. Complete the Install Wizard Complete all settings and dialogs as prompted.
4. License and Launch Ephesoft Transact 2019.2 License and launch Ephesoft Transact, then log in.

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

1. Complete the Prerequisites Check

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

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.2 once the installation is complete.

Refer to the following document to obtain a license:

Licensing Ephesoft Transact

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

Refer to the following resources for additional information:

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 a Shared Folder on the network for a multi-server environment.

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.

Figure 1: Change User Account Control settings in Windows Control panel

    • The User Account Control Settings screen appears.

Figure 2: User Account Control Settings

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

Figure 3: Network Connections example

    • Right click the network on which to disable IPv6, and click Properties from the popup menu.

Figure 4: Click Properties to change IPv6 settings

The Ethernet Properties screen appears.

Figure 5: Ethernet Properties settings

    • Scroll to the Internet Protocol Version 6 (TCP/IPv6) setting, and ensure that it is unselected or disabled.

Figure 6: 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: For user awareness, the environment variables are an automated part of running the Ephesoft Install Wizard.

Please continue to the next procedure.

2. Obtain and Launch the Install Wizard Package

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

1. If you have not already done so, 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.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, and this number may be subject to change.

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

Figure 7: Sample location of the installer zip file

Figure 8: Sample extraction dialog

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

Figure 9: Installer package contents

4. Launch the Windows Administrator Command Prompt app.

  • From the Windows Start menu, search with the term cmd or command prompt. The Command Prompt desktop app returns.

Figure 10: Access Command Prompt in Windows

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

Figure 11: Click Run as administrator

The Administrator Command Prompt windows appears:

Figure 12: Administrator: Command Prompt

5. Execute the following commands in sequence to navigate to the location of the Install Wizard file. 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>

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

As necessary, use the cd command to navigate to the directory from which you intend to run the Ephesoft Transact MSI Installer.

6. Execute the following command to launch the Install Wizard file.

C:\Transact2019>misexec /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.

Figure 13: Error message that may appear

The following example illustrates an alternate location of the installer MSI file:

C:\Windows\system32>msiexec /i C:\Users/Administrator\Downloads\ Windows_Ephesoft_Transact_2019.2_229\Ephesoft_2019.2.msi

C:\Windows\system32>

Once you execute the above command, 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 Welcome screen appears:

Figure 14: Install Wizard Welcome screen

Follow the dialogs as instructed to complete the Install Wizard:

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

Figure 15: End-User License Agreement screen

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

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

The following is one such message, cited as an example:

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.

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 17: .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 18: 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.

Define Logon Settings

5. Click Next when prerequisites are verified. The Install Wizard prompts you to enable the Windows Service Account log on credentials for the Ephesoft Transact Application (This is optional).

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

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.

Figure 20: Configure Database screen

8. Click Next. Follow the instructions for the selected database:

A. MariaDB Configuration

Note: New for Ephesoft Transact 2019.2, the Install Wizard does not install MariaDB as a part of the installation process. The MariaDB database must be configured prior to running the Install Wizard.

In Ephesoft Transact 2019.2, the Install Wizard allows you integrate an existing MariaDB server during installation of Ephesoft Transact.

For the latest information about MariaDB version support and MariaDB installation, refer to these documents:

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

  • Enter the MariaDB server configuration settings as prompted.

Figure 21: MariaDB Server Configuration

  • Once you have provided MariaDB server configuration, click Next to display the Database Login Configuration dialog.

Figure 22: Database Login Configuration

  • Enter the login credentials for MariaDB. Enter the root password and confirm.
  • Click Next to complete this MariaDB database setup. The MariaDB database configuration for this installation of Ephesoft Transact is now complete.
  • Continue to the following section to configure OpenOffice and proceed with the Install Wizard:

Configuring OpenOffice

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.

Figure 23: Configure Database screen: Microsoft SQL Server option

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 2014 is the officially supported version for Ephesoft Transact 2019.2.

Figure 24: Selecting the installation type for Microsoft SQL Server Integration

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

  • Selecting Both Options — The following screen appears if you select both of the options:
    • Enable Always-On feature for Microsoft SQL Server.
    • Windows Authentication

Figure 25: Local/Remote Microsoft SQL Server Configuration screen

      • Define the settings in the Local/Remote Microsoft SQL Server Configuration screen. In most cases, users proceed with the default settings.
      • Click Next once these settings are defined. The OpenOffice Configuration screen appears.
      • Continue to the section titled Configure OpenOffice.

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:

Figure 26: Select Oracle Database Server

  • The Local/Remote Oracle Server Configuration Information screen appears, with option to create new schema or configure existing Oracle schema. With either of the following two options, an SID is required.

Figure 27: Oracle schema selection

    • First Option: Select the first option to create new Oracle schema. The following screen appears:

Figure 28: 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:

Figure 29: Local/Remote Oracle Server Configuration — Use Existing Oracle Schema

      • Enter the appropriate information in the text fields for the Oracle database.
    • Click Next. The Oracle database configuration for this installation of Ephesoft Transact is now complete.
    • Navigate to the following topic to configure OpenOffice and continue with the Install Wizard.

Configure OpenOffice

After completing database setup in one of the previous three sections, the OpenOffice Configuration screen appears.

Figure 30: OpenOffice 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:

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

b. Follow these steps if using HTTP. Click Next:

The User Connectivity Settings screen appears, with option to choose one of the following connection types:

      • LDAP
      • Active Directory
      • Tomcat

Proceed to the next step in configuration — Configure User Connectivity Settings.

c. Follow these steps if using HTTPS: Click Next.

The following screen appears, allowing you to choose either Standard Form Authentication or PKI Authentication.

Note: If you select PKI Authentication, an additional field appears that allows you to navigate to and select the PKI Property file. Complete this field.

Figure 32: Authentication Mode

d. Click Next to configure the Certificate Details for PKI.

C:\Users\VINCEN~1\AppData\Local\Temp\SNAGHTML198e5a1a.PNG

Figure 33: JKS Server Cert and CA Cert details

    • Both certificates are defined on the server for this installation.
    • The Server Cert is a Java Keystore File (JKS) file for the server. Provide the JKS file and password for HTTPs configuration for the server certificate.
    • The CA Cert is the certificate file for a client system. Provide the CA Cert, Password and Alias Name for the client certificate.
  • Click Next. The Realm Settings for PKI screen appears.

Figure 34: Realm Settings for PKI

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

Figure 35: Connector Settings for PKI

  • Enter the information in the text fields and define the corresponding settings.
  • Click Next to complete this configuration for authentication. Proceed to define 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:

Figure 36: User Connectivity Settings

When selecting Tomcat, click Next. The Ephesoft Registration Information screen appears.

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.

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

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

Figure 39: User Connectivity Settings for Tomcat

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.

Figure 40: Ephesoft Registration Information screen

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

Figure 41: 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.2.
    • Select Yes — If this is a multi-server environment, select Yes.

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.

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

Figure 43: Change destination folder

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.

Figure 44: Ready to Install screen

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

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

Figure 46: Post-Installation Instructions

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

Figure 47: Ephesoft Transact 2019.2 setup is complete

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

Note: Ephesoft recommends restarting the system after finishing the installation, whether here or in the next procedure.

17. Click Finish to complete this step of the installation.

4. License and Launch Ephesoft Transact 2019.2

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 who has the application URL should be able to log in to Ephesoft Transact from the web browser for production-level operations.

Perform the following steps to license and launch Ephesoft Transact.

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

Licensing Ephesoft Transact 2019.2

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:

Figure 48: Typical Location for Ephesoft Transact License

The following steps provide abbreviated instructions for installing the license. For complete information, refer to the licensing 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.

Figure 49: Access Command Prompt in Windows

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

Figure 50: Click Run as administrator

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

Figure 51: 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:\Ephesoft\Dependencies\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. Important: You must execute this command twice. This is a hard requirement for Ephesoft Transact.

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

The following snapshot illustrates execution of the license batch file:

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

Figure 53: 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:

Figure 54: Service Control progress dialog

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

Figure 55: 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.2 home page appears.

Figure 56: Ephesoft Transact home screen

4. Select Administrator or Operator to log in.

5. Enter the Username and Password.

Figure 57: 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 installed, licensed and launched Ephesoft Transact 2019.2 on a Windows server with a fresh installation.

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