Transact

  1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Importing Documents
  6. Web Scanner
  7. Web Scanner Installation Guide

Web Scanner Installation Guide

Introduction

This document provides installation guidelines for the Ephesoft Transact Web Scanner. Four methods of installation are available:

  • Installation from the Ephesoft Transact user interface
  • Installation from the Ephesoft Transact directory
  • Manual installation (for non-administrators)
  • Silent installation

Prerequisites

The following prerequisites are required to successfully install the Web Scanner:

  • Windows operating system.

Note: Web Scanner is currently only available for Windows OS.

  • The Web Scanner version being installed must match the release version of Ephesoft Transact.
  • The user performing installation must have administrator permissions.

Note: Manual installation is available for non-administrators.

  • .NET Framework version 4.0 or above installed. If you do not have .NET Framework installed, access the Microsoft .NET Downloads page from the Internet and download your preferred version.

Installation Methods

To install the Ephesoft Web Scanner, refer to your preferred installation method below.

Installing from the Transact User Interface

To install the Web Scanner directly from the Ephesoft Transact user interface, follow the below instructions.

Important: This method requires administrator permissions.

  1. From the Transact homepage, select Operator > Scan New Documents.

Figure 1. Scan New Documents

  1. On the Information dialog box, click Download Service. This will download the EphesoftScannerService file.

A screenshot of a cell phone Description automatically generated

Figure 2. Information Message

  1. Once the download is complete, navigate to the Downloads folder and double-click the EphesoftScannerService file.

A screenshot of a cell phone Description automatically generated

Figure 3. EphesoftScannerService

Note: If you get a Windows warning message, on the pop-up screen, click More info > Run Anyway.

  1. The Web Scanner Setup Wizard displays. Click Next.

A screenshot of a cell phone Description automatically generated

Figure 4. Scanner Service Setup Wizard

  1. The Setup Wizard will check for .NET Framework version 4.0 or above.
  • If .NET Framework is installed on the machine, the Next button is enabled. Click Next to continue the installation.
  • If .NET Framework is not installed on your machine, a Download button will display. Click Download to be redirected to Microsoft Downloads, and install .NET Framework version 4.0 or above. When complete, return to Step 3 and restart the Setup Wizard.

Figure 5. .NET Framework Verification

  1. Install a Certificate Authority (CA) certificate for HTTPS configuration:
  • If you are using HTTPS protocol, select the checkbox, browse for the certificate, and enter the password. The system will automatically import and map the required files.
  • If you are not using HTTPS protocol, click Next.

Figure 6. Installing a CA Certificate

  1. By default, the Web Scanner is installed in the Program Files (x86) folder. If needed or preferred, specify a different destination folder for Web Scanner. Click Next.

Figure 7. Destination Folder Screen

  1. Click Install.

Figure 8. Install

Once the installation is complete, click Finish.

Figure 9. Finish Installation

You have successfully installed the Web Scanner from the Ephesoft Transact user interface. Restart your computer, and continue to Activating Web Scanner to start the service and begin scanning.

Installing from the Ephesoft Directory

Use these steps to install the Web Scanner from the Ephesoft SharedFolders directory.

Important: This method requires administrator permissions.

  1. Select Ephesoft > SharedFolders. Locate the following installer package: EphesoftScannerService.msi.
  2. Open Command Prompt as an administrator and install Web Scanner with the following command:
    msiexec /i EphesoftScannerService.msi.
  3. This initiates the Web Scanner Setup Wizard. Complete steps 4-9 in Installing from the Transact User Interface to finish the installation.

This completes installation instructions for the Web Scanner from the Ephesoft directory. Restart your computer, and continue to Activating Web Scanner to start the service and begin scanning.

Manual Installation

If you do not have administrator rights, follow the steps below to manually install the Web Scanner. This method is not compatible with systems configured with HTTPS protocol.

  1. Send a request to your internal systems administrator to obtain the .zip folder that contains the executable file. The administrator must place the .zip folder in the Ephesoft SharedFolders directory.
  2. Download the .zip folder on your local machine.
  3. Unzip the folder. Do not change the folder name.
  4. From the list of unzipped components, click EphesoftScannerConfigureMe.exe.

This completes manual installation instructions for the Web Scanner. Restart your computer, and continue to Activating Web Scanner to start the service and begin scanning.

Silent Installation

With silent installation, administrators can remotely and independently install, uninstall, and upgrade the Web Scanner client software to end-user workstations. Use the steps below to perform a silent installation of Web Scanner.

Important: This method requires administrator permissions.

  1. Contact Ephesoft Support to obtain and access the config.properties file.
  2. Open the config.properties file in a text editor.
  3. Edit the values to reflect your configuration as defined in the table below. If you are not using HTTPS protocol, leave the items indicated by HTTPS only blank.

Note: Your Ephesoft Transact instance and Web Scanner must have the same protocols.

Requirement LevelPropertyDescription
Mandatoryinstallation_directoryProduct installation directory
Mandatoryprotocol_type_http_or_httpsSelect 1 for HTTPS

Select 0 for HTTP

HTTPS onlytransact_cacert_file_pathIf protocol_type_http_or_https is 1, provide the CA certificate file path.
HTTPS onlytransact_cacerts_passwordIf protocol_type_http_or_https is 1, provide CA certificate password.
HTTPS & external CA certificate onlyis_custom_certificate.Select 1 to use an external certificate to configure Web Scanner for HTTPS.
HTTPS & external CA certificate onlywebscanner_custom_servercert_file_pathIf is_custom_certificate is 1, provide custom Web Scanner server certificate file path.
HTTPS & external CA certificate onlywebscanner_custom_servercert_passwordIf is_custom_certificate is 1, provide custom Web Scanner server certificate password.
HTTPS & external CA certificate onlywebscanner_custom_cacert_file_pathIf is_custom_certificate is 1, provide the custom Web Scanner CA certificate file.
HTTPS & external CA certificate onlywebscanner_custom_cacert_passwordIf is_custom_certificate is 1, provide custom Web Scanner CA certificate password.
Mandatoryis_custom_log_fileSet this property to 1 to change the default location of the log files for the Web Scanner service. Set to 0 if no change.
Optionalwebscanner_custom_log_file_pathIf is_custom_log_file is 1, provide the desired path where the Web Scanner application generates log file information on the user workstation.
  1. Save the file from your text editor as config.properties.

Figure 10. config.properties File with HTTP Protocol

  1. Open the Windows Administrator Command Prompt and run the following command:
Msiexec.exe /i <directory path of msi> /qb /norestart  USERINPUTSPATH=<directory path of properties file> 

Example:

Msiexec.exe /i  “ScannerService.msi” /qb /norestart  USERINPUTSPATH=C:\config.properties

Figure 11. Command Prompt

This completes silent installation instructions for the Web Scanner. Restart your computer, and continue to Activating Web Scanner to start the service and begin scanning.

Appendix

Activating Web Scanner

Once the Web Scanner is installed, users will need to perform a one-time access permissions step.

  1. From the Windows Start menu, locate EphesoftTransactScannerService. Click the arrow ( ▼ ) to expand the folder and click EphesoftTransactScannerServiceStart.

A screenshot of a cell phone Description automatically generated

Figure 12. Windows Start Menu

  1. Open the Ephesoft Transact homepage and click Operator > Scan New Documents.
  2. Click OK. A Windows Security Alert displays. Click Allow Access.

The Web Scanner is now activated and ready for use.

Performing a Silent Uninstallation

During silent installation, any previous version of Web Scanner will be automatically uninstalled and upgraded to the latest version of Web Scanner.

To manually uninstall the Web Scanner, follow the steps below.

  1. Open the Command Prompt.
  2. Run the following command:
Msiexec.exe /uninstall <directory path of msi>/qb /norestart

Example:

Msiexec.exe /uninstall “C:\EphesoftScannerService.msi” /qb /norestart

A screenshot of a cell phone Description automatically generated

Figure 13. Uninstalling Web Scanner

This completes silent uninstall instructions for the Web Scanner.

 

Was this article helpful to you? Yes No