Web Scanner User Guide

Introduction

This document provides user instructions for the Ephesoft Transact Web Scanner. The Web Scanner securely scans images into Ephesoft Transact from your client machine and supports both HTTP and HTTPS protocols. Images can be stored on the local system or on the server.

If you have not yet installed Web Scanner, complete the instructions provided in the Web Scanner Installation Guide before proceeding.

Web Scanner User Interface

The Web Scanner user interface contains three panels:

  • Thumbnail Stack: contains a stack of images.
  • Thumbnail List:displays thumbnails of the images.
  • Full Image: displays the image selected from the Thumbnail Panel.

A screenshot of a computer Description automatically generated

Figure 1. Web Scanner User Interface

The following navigation icons display in the toolbar:

  • First page ( << )
  • Previous page ( < )
  • Next page ( > )
  • Last page ( >> )

A screenshot of a social media post Description automatically generated

Figure 2. Web Scanner Toolbar

Further zoom and rotation functionalities are also available in the toolbar.

Creating and Configuring Scanner Profiles

Specific profile configurations are available to optimize Web Scanner functionality. Each batch class contains a default Web Scanner profile. Ephesoft recommends adding additional customized profiles to accommodate specific document types and batch classes.

To create and configure a scanner profile, complete the steps below.

Important: Administrator permissions are required.

  1. From the left sidebar, select Scanner Profiles and click Add.

A screenshot of a social media post Description automatically generated

Figure 3. Adding Scanner Profiles

  1. Specify a Profile Name.

Note: If a field in the Scanner Profiles configuration screen is missing or invalid, the field will display in red. Refer to the Appendix for a table of fields available for customization, and their customized values.

A picture containing screenshot Description automatically generated

Figure 4. Scanner Profile Fields

  1. Click Deploy. The scanner profile is completed.

This completes the steps required to create and configure Web Scanner profiles.

Operating the Web Scanner

The Ephesoft Web Scanner scans documents directly into Ephesoft Transact for batch class processing. Follow the below steps to use the Web Scanner.

  1. Open the Ephesoft Transact homepage and click Scan New Documents under the Operator menu.

A screenshot of a cell phone Description automatically generated

Figure 5. Transact Home Page

The following screen displays.

A screenshot of a social media post Description automatically generated

Figure 6. Web Scanner Screen

  1. Click the drop-down arrow ( ▼ ) and select the appropriate batch class for the documents being scanned.

A screenshot of a cell phone Description automatically generated

Figure 7. Selecting Batch Class

  1. If you are using multiple scanners, select the desired scanner from the drop-down menu.

A screenshot of a cell phone Description automatically generated

Figure 8. Selecting Scanner

  1. Click Start to start scanning and importing the images.
  2. After all the pages are scanned, click Finish. The following screen will appear.

A screenshot of a cell phone Description automatically generated

Figure 9. Finish Scanning

  1. Click OK to complete the scan.

This completes user instructions for the Web Scanner.

Key Features

Below are key features of the Ephesoft Transact Web Scanner:

  • Delete multiple images: You can delete multiple images by selecting one image at a time while holding the Ctrl key.
  • Rescan a page on the Review/Validation screen: If errors occur while scanning, you are provided with an option on the Review and Validation screens to rescan the selected page.

A screenshot of a cell phone Description automatically generated

Figure 10. Re-Scan

  • Viewing and organizing multiple thumbnails: Thumbnails can be dragged and reordered according to your viewing preferences.
  • Renaming batch description: You are provided with an option to edit the Scan folder name.

A screenshot of a cell phone Description automatically generated

Figure 11. Batch Description

  • Client-side image generation: This feature generates the .jpg files to display on the client’s side. This displays colored images on the user interface. To toggle between uploading to the client vs. server side, utilize the switch provided in the application.properties file found within the META-INF folder.

Page Number Label

In the Thumbnail panel, a page number displays below each image thumbnail. Each label begins with PG and is followed by the image count, beginning with PG 0. To start the page counter at PG 1, change the page_identifier_start_from_1 switch value to True. Refer to the Appendix for more information on configuring scanner profile settings.

//cdn.ephesoft.com/docs/wp-content/uploads/2015/11/word-image228.png

Figure 12. Page Labels

Page Navigation Shortcuts

To move between the images in the Thumbnail panel, use the shortcuts provided:

  • Next page: Ctrl + P / 0, or Right Arrow Key
  • Previous page: Ctrl + Shift + P / 0, or Left Arrow Key

To view details for these shortcuts, select More > Shortcuts.

//cdn.ephesoft.com/docs/wp-content/uploads/2015/11/word-image230.png

Figure 13. Scanner Shortcuts

Troubleshooting

Web Scanner Caching

The temp folder in the Ephesoft Transact scanner service directory is hidden to ensure additional security of processed data. It can be found in the following location by typing temp in the search bar: C:\Program Files (x86)\EphesoftTransactScannerService\temp)

Subfolders are created for each scanning job in the temporary folder. The name of this subfolder consists of two parts:

  • User ID of the operator running the scan
  • Numeric value generated from time and date

C:\Users\Ephesoft\AppData\Local\Microsoft\Windows\INetCache\Content.Word\webscanner3.png

Figure 14. Web Scanner Caching

This subfolder contains scanned files and their thumbnails.

C:\Users\Ephesoft\AppData\Local\Microsoft\Windows\INetCache\Content.Word\webscanner6.png

Figure 15. Cached Images

Multiple Users Error

Two users with the same username are not allowed to log in from the same server or from any other client machine. The following dialog box will display if an attempt is made:

A screenshot of a social media post Description automatically generated

Figure 16. Multiple User Error

Appendix

Changing Scanner Profile Settings

The following table provides all Web Scanner settings available for configuration, and their possible values.

SettingsPossible values
current_pixel_type
  • 0: 1-bit per pixel, black and white
  • 1: grayscale, normally 8 but can be 4- or 16-bit
  • 2: RGB color, 24-bit (can also be 48-bit, and rarely 15, 16, or 32-bit)
  • 3: indexed color (image has a color table) 8 or 4-bit.
  • 4: CMY color, 24-bit
  • 5: CMYK color, 32-bit
bit_depth

Specifies bit depth per color channel (e.g. 24-bit RGB has a bit depth 8).

  • 1: 1-bit per pixel, black and white
  • 8: grayscale, but some scanners may require it to be 4- or 16-bit
  • 24: RGB color, but some scanners may require it to be 48-bit, and rarely 15, 16, or 32-bit
multi_transfer
  • true: Scan multiple pages in one session
  • false: Scan and close the twain session
hide_ui

Hides the source user interface.

  • true
  • false
select_feeder

Controls the Automatic Document Feeder (ADF).

  • true
  • false
auto_scan
  • true: Web Scanner will scan pages before they are requested, and buffer them in the scanner or host PC. Use this option to achieve maximum throughput on ADF scanners.
  • false
enable_duplex

Sets the scanner for duplex scanning if the scanner supports it.

  • true: Scan Duplex
  • false: Scan Simplex
blank_page_mode

Signals Web Scanner to detect and discard blank pages.

  • true (discard): 1
  • false (do not discard): 0
blank_page_threshold

Specifies the ‘dark’ pixel percentage threshold, below which the page is considered ‘blank.’

  • between 0 and 1.0, The Default blank page threshold is: 0.02 (= 2% dark pixels).
dpi

This option specifies the dots per inch.

  • 200
  • 300
  • Values supported by other scanners
color
  • 0: 1-bit per pixel, black and white
  • 1: grayscale, normally 8 but can be 4- or 16-bit
  • 2: RGB color, 24-bit (can also be 48-bit, and rarely 15, 16, or 32-bit)
  • 3: indexed color (image has a color table) 8 or 4-bit.
  • 4: CMY color, 24-bit
  • 5: CMYK color, 32-bit
paper_size
  • 0: NONE
  • 1: A4
  • 2: B5
  • 3: US Letter
  • 4: US Legal
  • 5: A5
  • 6: B4
  • 7: B6
  • 9: US Ledger
  • 10: US Executive
  • 11: A3
  • 12: B3
  • 13: A6
  • 14: C4
  • 15: C5
  • 16: C6
  • 17: 4A0
  • 18: 2A0
  • 19: A0
  • 20: A1
  • 21: A2
  • 22: A7
  • 23: A8
  • 24: A9
  • 25: A10
  • 26: ISOB0
  • 27: ISOB1
  • 28: ISOB2
  • 29: ISOB5
  • 30: ISOB7
  • 31: ISOB8
  • 32: ISOB9
  • 33: ISOB10
  • 34: JISB0
  • 35: JISB1
  • 36: JISB2
  • 37: JISB3
  • 38: JISB4
  • 39: JISB6
  • 40: JISB7
  • 41: JISB8
  • 42: JISB9
  • 43: JISB10
  • 44: C0
  • 45: C1
  • 46: C2
  • 47: C3
  • 48: C7
  • 49: C8
  • 50: C9
  • 51: C10
  • 52: US Statement
  • 53: Business Card
back_page_rotation_multiple

Specifies the multiples of 90 degrees in which back pages should be rotated.

  • 1: 90 degrees
  • 2: 180 degrees
  • 3: 270 degrees
front_page_rotation_multiple

Specifies the multiples of 90 degrees in which front pages should be rotated.

  • 1: 90 degrees
  • 2: 180 degrees
  • 3: 270 degrees
enable_rescanEnables / disables rescanning of scanned documents. Rescan is enabled by default.
enable_deleteEnables / disables ability to delete scanned document pages. This property is enabled by default.