Configuration of a Web capture control

Configure the Web capture control to:

  • Selectively hide specific buttons at design time and only display the selected ones at runtime.

  • Customize the icons used to match the look and feel of your site. The icons reflect the image provided at the design time.

  • Prevent users from editing (moving, resizing, deleting, and changing the text).

When you add a Web capture control, the Web capture control toolbar appears at runtime. Refer to the following table for the buttons available on the Web capture control toolbar.

Button/Label Name Icon Description

File Import

Use this button to upload a file at runtime.

  • When you enter a static document ID, the system creates a new document and disables the Enable scanning and Import options at runtime.
  • TotalAgility supports all image types and PDFs but does not support annotations in PDFs.

Add Page From File

Adds pages by importing the file from your local computer.

Save

Use this button to do the following:

  • Save created annotations.

  • Apply created redactions and burn them to the image if you have the required permissions.

You must click the Save button after scanning or importing pages, or after performing some batch editing, such as moving and deleting pages to save the document and folder. To avoid using the Save button and allow everything to be auto-saved, you can assign the WebCapture Save action to a particular WebCapture control event, such as DocumentChanged or IngestionCompleted, in Form Designer.

Select Scanner

Displays a list of scanners to choose from.

Scan

Scans pages using the selected scanner.

Add Page From Scanner

Adds pages to the existing scanned pages.

Previous Page

Use this button to go to a previous page.

Page Counter

Shows the page count.

Next Page

Use this button to go to the next page.

Delete Page

Use this button to delete pages that have been incorrectly scanned. Clicking this button displays a confirmation message, "Are you sure you want to delete page x of y". (x is the current page and y is the total pages). Once confirmed, the selected page is deleted. The index of the pages is updated accordingly.

Move page up

Use this button to move the current page up. If you try to move the first page up, a warning message appears.

Move page down

Use this button to move the current page down. If you try to move the last page down, a warning message appears.

Moving the page up or down, updates the page index accordingly. For example, in a 6-page document, if page 3 is the current page and you move this page up, the current page moves to page 2. The index for this page displays "page 2 of 6".

Zoom In

Use this button to magnify the view.

Zoom Out

Use this button to constrict the view.

Full Size

Use this button to view the image at its original size.

Best Fit

Use this button to fit the entire image to the viewer.

Fit To Width

Use this button to fit the image to the width of the viewer.

Draw Highlight

Use this button to highlight the text.

Draw Line

Use this button to draw a line.

Draw Freehand

Use this button to create a freehand annotation.

Draw Rectangle

Use this button to create rectangle annotation.

Draw Text

Use this button to create text annotation.

Undock

Use this button to undock the document viewer from the main form and display it in a separate browser window so that it can be viewed on a second monitor. Undocking a document viewer helps in viewing the image or document on one screen while completing the form on the other screen. For example, you can view the image of the invoice on one screen while completing the other details in the form on the second screen.

  • The inner size of the undocked image viewer in the new browser window matches the size of the original Web capture control.

  • The Undock button is hidden in an undocked document viewer.

  • When the undocked image window is closed, the image reappears on the main form as docked (original form).

  • By default, the Undock button is hidden for upgraded forms. You can set the button in the Designer to display at runtime.

Add sticky note

Allows you to add a sticky note.

Draw Mask

Use this button to draw the area to mask the image.

Permanent Redaction

Use this button to permanently alter the image, so that you can remove sensitive information that should not reside in your database.

Download

Use this button to download the images (TIFF images) of the current document or page. You can download the TIFF images for documents without source file.

If a document has multiple images (for example, source file, TIFF images and generated PDF), you can choose the image type to download.

Print

Use this button to print page, document and folder (all documents within the folder).

Help

Use this button to navigate to help.

By default, all the buttons of the Web capture control toolbar appear on the Web capture control toolbar. You can restrict a button from displaying at runtime, change the image of a toolbar button, and allow editing of annotations.

  1. On the Control - properties panel of the Web capture control, click the Configuration tab.
  2. Configure the following properties.
    Folder type

    This folder type is used when creating a new folder. If you do not specify the folder type, the Web capture control uses the default folder type.

    Folder ID

    Select a global variable, form variable, or form control to store the returned folder ID or enter a static value.

    • If the document ID field is mapped to a variable, control, or inline value, the folder ID value is not used.

    • If the folder ID is mapped to a variable, control, or inline value, a new document is created in that folder and the document ID variable or control is set to its ID.

    • If the folder ID is mapped to a variable or control without a value, a new folder and new document are created and both variables and controls are set to their respective IDs.

    • You can select the Folder ID property of the control in an event.

    Document type

    This document type is used when creating a new document. If you do not specify the document type, the Web control uses the default document type.

    Document ID

    Select a global variable, form variable, or form field to store the returned value or enter a static value. If you enter a static document ID, the system creates a new document.

    Scan/VRS profile

    Scan/VRS profile to scan the document.

    If you leave this field empty, the control uses the default Scan/VRS profile.

    Display image format

    The format for the display image. Select either PNG or JPG.

    Use eDoc rendering

    Indicates whether the eDocs (Microsoft Office and PDF documents) should be rendered so that they can be viewed in TotalAgility.

    If selected, allows the rendering of the electronic documents so that they can be viewed in TotalAgility forms.

    Toolbar buttons

    Allows you to configure buttons for the Web capture control toolbar. See Configure buttons of a Web capture control toolbar.

  3. Click Save.