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

Introduction

Revision 2 — August 14, 2019

Document Overview

This document provides information about installing Ephesoft Transact 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 sequence of tasks as listed in the table below.

Installation Task General Scope of Activity
1. Complete the Prerequisites Prepare for installation by gathering installation resources and verifying that the environment and databases are 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

Perform these steps to prepare for all conditions required for successful software installation and startup:

1. Operating System — Verify that Ephesoft Transact 2019.2 is supported for the operating system and hardware environment. Refer to the following resources for additional information:

2. Database — Obtain or verify the database type and connection settings using the documents cited immediately above. The following database information is required when you run the Install Wizard:

  • Username and password
  • Database connection parameters

Important: Please observe the following important information about database configuration with Ephesoft Transact 2019.2:

    • The MariaDB, Microsoft SQL Server or Oracle database must be installed and configured separately, prior to installing Ephesoft Transact 2019.2. The Ephesoft Transact 2019.2 Install Wizard does not install any database.
    • If you intend to use an existing MariaDB database that was installed with the installer for a previous Ephesoft Transact release, or if you need to install a new MariaDB database for this deployment, you must install or migrate the MariaDB database prior to running the Install Wizard for Ephesoft Transact 2019.2. Refer to the following document for additional information:

Install and Migrate MariaDB or MySQL for Windows

3. Internet — Verify that internet connectivity is available for this installation. Later in this document, you will be required to download the Ephesoft Transact install package.

4. .NET 4.5.2 — Verify or complete .NET 4.5.2 installation on the server before running the Install Wizard.

  • The Install Wizard does not allow the user to complete the installation without meeting this requirement.
  • .NET 4.5.2 is available for download from the Microsoft website.

5. SharedFolders — Confirm the SharedFolders requirement for this installation. The Install Wizard configures SharedFolders in one of two ways:

  • Local disk — By default, the Install Wizard installs SharedFolders on the local system and where the user installs Ephesoft Transact.
  • Network Server — If you plan to use SharedFolders on a network system, you must complete the following additional steps to prepare for using the Install Wizard:

Obtain the Universal Naming Convention (UNC) server name for the network server.

Create a base network path on that server that will host SharedFolders.

Note: The Install Wizard creates SharedFolders on the network server in a later step. The network server and base network path must be online and available when you run the Install Wizard.

Important: Ephesoft strongly recommends that you install the SharedFolders component on a network shared folder in all cases, and not the local server, whether for single-server or multi-server installations.

As a best practice, setting SharedFolders on a network server better allows for future growth and scalability:

    • Future upgrades may entail increased CPU or memory upgrades, or increasing the number of servers in the Ephesoft Transact deployment.
    • In all cases, future upgrades are easier to set up when you define SharedFolders on a UNC network server and path, and not on the local system.

6. User Access Control — Log onto the Windows system and disable (turn off) the user access control (UAC).

Important: This is a temporary setting, and you may 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 1: Change User Account Control settings in Windows Control Panel

The User Account Control Settings screen displays.

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

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

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

a. Browse to Control Panel > Network and Internet > Ethernet.

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

 Figure 3: Network Connections Example

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

Figure 4: Click Properties to Change IPv6 Settings

The Ethernet Properties screen displays.

Figure 5: Ethernet Properties Settings

d. Scroll to the Internet Protocol Version 6 (TCP/IPv6) setting, and ensure that it is disabled (i.e., ensure that the check box is clear).

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

8. Windows Service Account User — Either create a Windows Service Account user on the Windows system or confirm the username and password for an existing Windows Service Account user to be used with Ephesoft Transact.

9. 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. Contact your Ephesoft partner, sales representative, or Professional Services engineer for access to the Install Wizard package.

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

The xxx is an Ephesoft build number that may be subject to change.

3. Extract all contents of this zip file to a location that is easy to find. To extract the file, right-click the file, and from the pop-up menu, click Extract All.

Figure 7: Click Extract All …

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

Figure 8: Installer Package Contents (Windows Zip App)

4. Launch the Windows Administrator Command Prompt app.

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

Figure 9: Access Command Prompt in Windows

b. Right-click Command Prompt, then click Run as administrator.

Figure 10: Click Run as administrator

The Administrator Command Prompt windows displays:

Figure 11: Administrator: Command Prompt

5. Execute the following command to navigate to the location of the Install Wizard file. Your destination directory may differ:

C:\cd Transact2019
C:\Transact2019>

The above command navigates to a sample installation directory (Transact2019) from Windows root.

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

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

7. Continue to the next procedure.

3. Complete the Install Wizard

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

 Figure 13: 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 14: 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 15: Ephesoft Prerequisites Check Screen

Ephesoft Transact performs this check, and a warning may appear if there is a possible issue. If a warning displays, 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.

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 16: .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 displays in this case. Be aware of the following information:
      • Click Download to navigate to the appropriate web link.
      • Download and install the .NET 4.5.2 Framework.
      • Once you have completed installation of .NET 4.5.2 Framework, return to this step in the Install Wizard.

4. Click Next once the Install Wizard verifies .NET Framework 4.5.2 on the server.

Transact performs a check of Microsoft® Visual C++ Redistributables.

Figure 17: 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 choose the account to use with the Ephesoft Transact Server.

Figure 18: Log On Credentials and Account Selection

 

In most cases, users select Local System Account.

To use another existing account, select This Account, and be aware of the following information:

    • Use this option with a service account that has access to the SharedFolders component located on another network server.
    • Enter the username and password for a local Windows Server Account that already exists for this function.
    • To use this option, the account must already exist before using this account in the Install Wizard.

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

Select and Set Up the Database

7. Select the database to configure. Click Next.

Figure 19: Configure Database Screen

8. Follow the instructions for the selected database:

  • A. MariaDB Server Configuration — the default selection in the Install Wizard
  • B. Microsoft SQL Server Configuration
  • C. Oracle Database Server Configuration

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.

a. Enter the MariaDB server configuration settings as prompted.

Figure 20: MariaDB Server Configuration

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

Figure 21: Database Login Configuration

 

c. Enter the login credentials for MariaDB. Enter the root password and confirm.

d. Click Next to complete this MariaDB database setup. The MariaDB database configuration for this installation of Ephesoft Transact is now complete.

e. Continue to this 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.

a. Select Microsoft SQL Server on the Configure Database screen, as illustrated below.

Figure 22: Configure Database Screen: Microsoft SQL Server Option

The Install Wizard prompts you for integration information, as illustrated in the following snapshot.

b. Select any additional options, as needed for this installation. For additional information about support for Microsoft SQL Server, refer to Platform Configuration and Third-Party Integrations – Ephesoft Transact 2019.2.

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

For additional information about MS SQL Server setup, refer to Prerequisites | Configuring Named Instance for Microsoft® SQL Server Prior to Installing Transact 2019.2.

c. Select the following two options:

    • Enable Always-On feature for Microsoft SQL Server version 2012 or later.
    • Windows Authentication

The following screen displays if you select both of the options:

Figure 24: 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 displays.
    • 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.

a. Select Oracle Database Server in the Configure Database screen, as illustrated below:

Figure 25: Select Oracle Database Server

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

Figure 26: Oracle Schema Selection
    • First Option: Select the first option to create new Oracle schema. The following screen displays:
Figure 27: 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 displays:
Figure 28: Local/Remote Oracle Server Configuration — Use Existing Oracle Schema

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

c. Click Next. The Oracle database configuration for this installation of Ephesoft Transact is now complete.

d. Continue to the next topic to configure OpenOffice and continue with the Install Wizard.

Configure OpenOffice

After completing database setup, the OpenOffice Configuration screen displays.

Figure 29: OpenOffice Configuration

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

Configure Authentication Mode

The Authentication Mode dialog displays, as illustrated below:

Figure 30: Choose an Authentication Mode

10. Select the appropriate Authentication Mode for this installation.

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 displays, 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 displays, allowing you to choose either Standard Form Authentication or PKI Authentication.

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

Figure 31: Authentication Mode

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

C:\Users\VINCEN~1\AppData\Local\Temp\SNAGHTML198e5a1a.PNG
Figure 32: 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 displays.
Figure 33: Realm Settings for PKI
    • Enter the appropriate information in the text fields and click Next. The Connector Settings for PKI screen displays.
Figure 34: 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 35: User Connectivity Settings

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

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

11. Define the User Connectivity Settings as prompted for LDAP, Active Directory or Tomcat.

a. LDAP — The following figure 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 36: LDAP Configuration for User Connectivity Settings

b. Active Directory — The following figure 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 37: Active Directory Configuration for User Connectivity Settings

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

Figure 38: User Connectivity Settings for Tomcat

Enter Ephesoft Registration, SharedFolders and Installation Information

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

Figure 39: Ephesoft Registration Information Screen

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

Important: With this screen, you define settings for the SharedFolders component, as described in the section titled 1. Complete the Prerequisites.

Figure 40: Shared Folder Configuration Screen
  • Selecting No — If this is the first Windows system on which installing Ephesoft Transact, select No to indicate that there is not already a SharedFolders component.

Select No if you are performing this installation in a single-server environment, or if you are installing the first node of a multi-server environment. In this case, the Install Wizard installs the SharedFolders component with Ephesoft Transact 2019.2.

  • Selecting Yes — Select Yes if this is the second or subsequent node in a multi-server deployment. Use this option when you are adding a server to an existing cluster of servers that already has the same release of Ephesoft Transact installed.

If you select Yes, you must already have an existing installation folder available on a separate server on the network. If this is a multi-server environment, also refer to additional information available at Install & Upgrade — Multi-Server.

13. Click Next. The Installation Folder screen displays.

Figure 41: Installation Folder Setup Screen

Users often choose the default installation location, but change the location as needed.

If SharedFolders exists elsewhere on the network, and you wish to use that SharedFolders component for this installation, select Install Shared folder separately, and define the network location.

Figure 42: Change Destination Folder

14. Click Next in the Installation Folder screen.

Run and Finish the Install Wizard

The Ready to Install screen displays 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 43: Ready to Install Screen

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

Figure 44: 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 the installation.

Figure 45: Post-Installation Instructions

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

Figure 46: Ephesoft Transact 2019.2 setup is complete

You have the option restart the system you finish 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.

18. Re-enable 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.

    • 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 47: Change User Account Control settings in Windows Control Panel

The User Account Control Settings screen displays.

Figure 48: User Account Control Settings
    • 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.

19. Continue to the next procedure.

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 these tasks, any authorized operator or administrator who has the application URL should be able to log in to Ephesoft Transact from the web browser for 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

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

{Ephesoft directory}\Dependencies\license-util\

The following figure illustrates the typical location for the license:

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

2. Launch the Windows Administrator Command Prompt app.

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

Figure 50: Access Command Prompt in Windows

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

Figure 51: Click Run as administrator

The Administrator Command Prompt windows displays:

Figure 52: Administrator: Command Prompt

c. Navigate to the directory that contains the license file. The following command illustrates 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: Execute this command again, for a total of two times:

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

The following figure illustrates execution of the install-license.bat batch file twice:

Figure 53: Command Prompt License Installation Commands

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

a. In the Windows Control Panel, browse to Services | Desktop App.

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

Figure 54: 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 55: Service Control Progress Dialog

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

Figure 56: Ephesoft Transact Service Is Running

d. Close the Windows Service Control utility.

4. 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 displays.

Note: During initial startup, allow time for the background configuration processes to complete.
The initial startup after installation may require a few minutes.

Figure 57: Ephesoft Transact Home Screen

5. Select Administrator or Operator to log in.

6. Enter the username and password.

Figure 58: Login Screen

Important: The system may require additional time to complete the initial login.

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: