› Importing documents › Web Scanner › Web Scanner installation

Web Scanner installation

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

Prerequisites

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

  • Windows operating system.

    Web Scanner is currently only available for Windows OS.

  • The Web Scanner version being installed must match the release version of Transact.

  • The user performing installation must have administrator permissions.

    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 Transact Web Scanner, refer to your preferred installation method below.

Installing from the Transact user interface

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

This method requires administrator permissions.

  1. From the Transact home page, select Operator > Scan New Documents.
  2. On the Information dialog box, click Download Service. This will download the EphesoftScannerService file.
  3. Once the download is complete, navigate to the Downloads folder and double-click the EphesoftScannerService file.

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

  4. The Web Scanner Setup Wizard displays. Click Next.
  5. 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.

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

  7. 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.
  8. Click Install.
  9. Once the installation is complete, click Finish.

    You have successfully installed the Web Scanner from the Transact user interface.

  10. Restart your computer and continue to Activate Web Scanner to start the service and begin scanning.

Installing from the Transact folder

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

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–10 in Installing from the Transact user interface to finish the installation.

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. The installation .zip folder is available in the Ephesoft ShareFolders folder.
  2. Download the .zip folder from the SharedFolders directory to your local machine.
  3. Extract the folder. Do not change the folder name.
  4. From the list of unzipped components, click EphesoftScannerConfigureMe.exe.

    You have successfully installed the Web Scanner.

  5. Restart your computer and continue to Activate 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.

This method requires administrator permissions.

  1. The config.properties file is by default available in the Transact SharedFolders folder. Open the config.properties file in a text editor.
  2. 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.

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

    Requirement Level

    Property

    Description

    Mandatory

    installation_directory

    Product installation directory

    Mandatory

    protocol_type_http_or_https

    Select 1 for HTTPS

    Select 0 for HTTP

    HTTPS only

    transact_cacert_file_path

    If protocol_type_http_or_https is 1, provide the CA certificate file path.

    HTTPS only

    transact_cacerts_password

    If protocol_type_http_or_https is 1, provide CA certificate password.

    HTTPS & external CA certificate only

    is_custom_certificate.

    Select 1 to use an external certificate to configure Web Scanner for HTTPS.

    HTTPS & external CA certificate only

    webscanner_custom_servercert_file_path

    If is_custom_certificate is 1, provide custom Web Scanner server certificate file path.

    HTTPS & external CA certificate only

    webscanner_custom_servercert_password

    If is_custom_certificate is 1, provide custom Web Scanner server certificate password.

    HTTPS & external CA certificate only

    webscanner_custom_cacert_file_path

    If is_custom_certificate is 1, provide the custom Web Scanner CA certificate file.

    HTTPS & external CA certificate only

    webscanner_custom_cacert_password

    If is_custom_certificate is 1, provide custom Web Scanner CA certificate password.

    Mandatory

    is_custom_log_file

    Set this property to 1 to change the default location of the log files for the Web Scanner service. Set to 0 if no change.

    Optional

    webscanner_custom_log_file_path

    If is_custom_log_file is 1, provide the desired path where the Web Scanner application generates log file information on the user workstation.

  3. Save the file from your text editor as config.properties.
  4. 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
  5. Restart your computer and continue to Activate Web Scanner to start the service and begin scanning.

Activate 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, select EphesoftTransactScannerService > EphesoftTransactScannerServiceStart.
  2. Open the Transact home page and click Operator > Scan New Documents.

    The Web Scanner is now activated and ready for use.

Perform 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

Using a proxy server

When network or security requirements dictate that a proxy server be used to facilitate communication with the Transact server, use the following steps to configure Web Scanner to connect to the proxy server instead of using a direct connection.

  1. Stop the Transact Scanner Service.
  2. Open the <EphesoftScannerService_Installation_Dir>\Service.bat file for editing.
  3. Replace the existing command: 
     .\jre\bin\java -Xms800m -Xmx1G -Xconcurrentio -Dspring.config.location=config/application.properties -cp ./lib/*
com.ephesoft.scannertoolkit.Application

    With the following command: 

    .\jre\bin\java -DproxyHost={Proxy Server IP} -DproxyPort={Proxy Server Port} -Xms800m -Xmx1G
-Xconcurrentio -Dspring.config.location=config/application.properties -cp ./lib/* com.ephesoft.scannertoolkit.Application
    Example: 
    .\jre\bin\java -DproxyHost=123.4.567.89 -DproxyPort=8080 -Xms800m -Xmx1G -Xconcurrentio
-Dspring.config.location=config/application.properties -cp ./lib/* com.ephesoft.scannertoolkit.Application
  4. Save and close the Service.bat file.
  5. Start the Transact Scanner Service.
  6. Clear your browser cache and launch the Web Scanner from Transact.