Install Ephesoft Transact 2019.2 – Single and Multi-Server

Introduction

Revision 4 — October 8, 2019

This document describes how to install Ephesoft Transact 2019.2 in the following environments:

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

Installation Overview

The process of installing Ephesoft Transact 2019.2 follows this general sequence of tasks.

Installation Task General Scope of Activity
Prerequisites Prepare for installation by gathering installation resources and verifying that the environment and databases are supported.
Obtain and Launch the Install Wizard Package Launch the 2019.2 Install Wizard with the Windows Command Prompt. Complete all settings and dialogs as prompted.
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.

Prerequisites


Perform these steps to prepare for a successful software installation and startup:

  1. Verify that Ephesoft Transact 2019.2 is supported on your operating system. Refer to Ephesoft Transact 2019.2 — Platform Configuration and Third-Party Integrations for additional information.
  2. Use the document cited above to confirm and verify that your database version is supported.
  3. The following database information is required when you run the Install Wizard:
    • Username and password
    • Database connection parameters

Important: Review the following 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 Install and Migrate MariaDB or MySQL for Windows for additional information.
  1. Verify that internet connectivity is available for this installation.
  2. Determine if you need to perform a single-server or multi-server installation.

Important: Installation steps unique to a multi-server installation are identified accordingly throughout this document.

  1. 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.
  2. 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:
  1. Obtain the Universal Naming Convention (UNC) server name for the network server.
  2. Create a base network path on that server that will host the SharedFolders directory.

Note: The Install Wizard creates the SharedFolders directory 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 recommends installing the SharedFolders directory on a network shared folder and not the local server. All multi-server installations require the SharedFolders to be on a network server as all Ephesoft Transact servers will point to the same location.

Setting SharedFolders on a network server allows for future growth and scalability:

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

User Instructions

Prepare the Server for Installation

Perform these steps to prepare the server to install Ephesoft Transact 2019.2.

  1. Log onto the Windows system and disable (turn off) the user access control (UAC).

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

The User Account Control Settings screen displays.

Figure 2: 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 2. 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 3: Network Connections Example

c. Right-click the network on which to disable the 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. Clear the Internet Protocol Version 6 (TCP/IPv6) check box.

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.

  1. Create a Windows service account or confirm the username and password for an existing Windows service account to be used with Ephesoft Transact.

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 2019.2 Install Wizard as instructed by Ephesoft. This is a zipped file with the following filename:

WINDOWS_Ephesoft_Transact_2019.2_xxx
Note: The xxx is an Ephesoft build number that is subject to change.

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

Figure 7: 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 8: 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_2019.2.msi

The following screen displays:

https://ephesoft.com/docs/wp-content/uploads/2019/06/word-image-15.png

Click Run to continue launching the Ephesoft Install Wizard.

The Ephesoft Transact 2019.2 Setup screen displays.

  1. Click Next.

Figure 9: The Ephesoft Transact 2019.2 Setup Screen

The End-User License Agreement displays.

Figure 10: End-User License Agreement

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

The Ephesoft Prerequisites Check displays.

Figure 11: 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 12: .NET Framework 4.5.2 Installation

The following factors 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. Follow these steps:

a. Click Download and go to the appropriate link.
b. Download and install the .NET 4.5.2 Framework.
c. Once you have completed the installation of .NET 4.5.2 Framework, continue to step 5.

  1. Click Next. The Install Wizard performs a check of Microsoft® Visual C++ Redistributables.

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

  1. When the Setup Successful message displays, click Close. Continue to Define Log On Settings.

Define Log On Settings

The Install Wizard prompts you to choose the account to use with the Ephesoft Transact Server. Perform the steps below.

Figure 14: Log On Credentials and Account Selection

  1. In most cases, users select Local System Account.
  2. To use another existing account, select This Account, and note the following information:

a. Use this option with a service account that has access to the SharedFolders component located on another network server.
b. Enter the username and password for a local Windows server account that already exists for this function.

  1. Click Next. Continue to Select and Set Up the Database.

Select and Set Up the Database

The Configure Database screen displays. Perform the steps below to select and set up your database.

  1. Select the database to configure. Click Next.

Figure 15: Configure Database Screen

  1. Follow the instructions for the selected database:
  • MariaDB Server Configuration — the default selection in the Install Wizard
  • Microsoft SQL Server Configuration
  • Oracle Database Server Configuration

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 16: MariaDB Server Configuration

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

Figure 17: 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 the Configuring OpenOffice section to configure OpenOffice and proceed with the Install Wizard:

B. Microsoft SQL Server Configuration

Before you configure Microsoft SQL Server, refer to Prerequisites | Configuring Named Instance for Microsoft® SQL Server Prior to Installing Transact 2019.2, and complete the steps. Then, follow these steps below to configure this database during the installation of Ephesoft Transact.

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

Figure 18: 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.
c. Review the following two options when selecting the installation type for Microsoft SQL server and choose only if applicable to your installation process. This is an optional step.

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

The following screen displays if you select both options:

Figure 20: 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 21: 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 22: Oracle Schema Selection

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

Figure 23: Local/Remote Oracle Server Configuration — Create New Oracle Schema

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

2. Second Option: Select the second option to use existing Oracle schema. The following screen displays:

Figure 24: 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 25: OpenOffice Configuration

a. 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 26: Choose an Authentication Mode

a. Select the appropriate Authentication Mode for this installation. 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 Configure User Connectivity Settings for the next step in configuration.

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 27: Authentication Mode

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

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

Figure 28: 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 29: Realm Settings for PKI

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

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

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

a. Define the User Connectivity Settings as prompted for LDAP, Active Directory or Tomcat.
b. 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 32: LDAP Configuration for User Connectivity Settings

c. 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 33: Active Directory Configuration for User Connectivity Settings

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

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

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

Figure 35: Ephesoft Registration Information Screen

The Shared Folder Configuration screen displays.

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

  1. The following steps vary depending on a single or multi-server installation.
  • If installing on a single-server environment, or if you are installing the first server in a multi-server environment, select No.
  • If installing on the second (third, fourth, etc.) server in a multi-server environment, select Yes.

For additional information on multi-server environments, refer to Multi-Server Installation.

  1. Click Next.
  2. The Installation Folder screen displays.

Figure 36: Installation Folder Setup Screen

The default installation location is commonly used, but the location may be changed as needed.

  1. Select the Install Shared folder separately check box and define the network location if using SharedFolders on a network for this installation.

Note: For multi-server deployments, the SharedFolders directory must be installed on a file share that will be accessible by all servers in the cluster.

Figure 37: Change Destination Folder

  1. Click Next in the Installation Folder screen.

Run and Finish the Install Wizard

The Ready to Install screen displays after you have chosen the folder location.

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

  1. Click Install.

Figure 38: Ready to Install Screen

Figure 39: Status Bar of the Install Wizard Progress

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

Figure 40: Post-Installation Instructions

  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 41: Ephesoft Transact 2019.2 Setup is Complete Screen

You have the option to restart the system when you finish the Install Wizard.

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

  1. Click Finish.
  2. When the installation is complete, re-enable the 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 reactivates 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 42: Change User Account Control settings in Windows Control Panel

The User Account Control Settings screen displays.

Figure 43: 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.
c. Continue to License and Launch Ephesoft Transact 2019.2.

License and Launch Ephesoft Transact 2019.2

To complete the installation, refer to Licensing Ephesoft Transact 2019.2.

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 2019.2 home page displays.

Figure 44: Ephesoft Transact Home Screen

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

Figure 45: Login Screen

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

Multi-Server Installation

This document provides instructions on how to install Ephesoft Transact in a single or multi-server environment. The steps for both environments are similar up to the section Enter Ephesoft Registration, SharedFolders, and Installation Information of this document where the Ephesoft Registration Information screen is described.

If installing in a multi-server environment, it is important for users to follow the instructions outlined in Enter Ephesoft Registration, SharedFolders, and Installation Information.

Conclusion

This completes the installation process.