Add a Web Capture action

Use the Web Capture action to perform actions, such as scan, select scanner, import and delete pages.

You can associate a Web Capture action on any button click and not just depend on the Web Capture control toolbar to perform these actions.

The Web Capture Control supports the following events:

  • OnDocumentSaveComplete: When a scanned or uploaded document is saved, this event is fired.

  • IngestionStarted: When you scan or upload a document, this event disables the File Upload control because, during scan the folder is locked and it is not possible to upload a file.

  • IngestionCompleted: When scan or upload is completed and new pages are ingested, this event saves the changes and enables the File Upload control.

  • DocumentChanged: When a Web Capture control changes the document structure, that is, when a page is deleted or moved within the document, this event is fired.

  • PageIndexChanged: When the selected page index changes, this event is fired.

  • ControlUndocked and ControlDocked: When a document viewer of the Web Capture control is undocked (detached) or docked, these events are fired.

Note The Next Page and Previous Page actions and similar toolbar buttons do not change the selected page index; they just scroll the viewer to the next or previous page.

  1. On the Form Modeling bar, click Actions.
  2. On the Actions page, click Add Generic Add.
  3. On the Type list, select Web Capture.
  4. Enter a Name and Description for the action.
  5. Optionally, configure a unique action for each language separately. See Configure multilingual actions for a form or control for more information.
  6. In the Web Capture box, consume the capture control as needed.
  7. On the Actions list, select an action. See the following table for a list of available actions.

    Action

    Description

    Save

    Allows to automatically save the data.

    Import

    Allows user to choose files for import into new document.

    Add Page(s) from File

    Allows user to choose files that need to be added to the currently displayed document.

    Select Scanner

    Displays the Select Scanner dialog box where you can select the scanner.

    Scan

    Scans images from scanner and adds them to new document.

    Add Page(s) from Scanner

    Scans images from scanner and adds them to the currently displayed document.

    Previous Page

    Scrolls the viewer to the previous page.

    Next Page

    Scrolls the viewer to the next page.

    Delete Page

    Deletes the currently selected page.

    Move Page Up

    Moves the currently selected page up.

    Move Page Down

    Moves the currently selected page down.

    Zoom Out

    Constricts the viewer.

    Zoom In

    Magnifies the viewer.

    Full Size

    Displays image in its real size.

    Best Fit

    Fits the entire image to the viewer.

    Fit To Width

    Fits the image to the width of the viewer.

    Draw Highlight

    Allows to draw highlight annotation.

    Draw Line

    Allows to draw line annotation.

    Draw Freehand

    Allows to draw freehand annotation.

    Draw Rectangle

    Allows to draw rectangle annotation.

    Draw Text

    Allows to draw text annotation.

    Undock

    Allows to undock (detach) the image or document viewer from the main form, and move it to a separate browser window so that image can be displayed on a second monitor.

    Draw Mask

    Allows to draw the area to mask on the image.

    Permanent Redaction

    Allows to permanently alter the image, so that you are able to remove sensitive information that should not reside in your database.

    Note The Import, Add Page(s) from File, Select Scanner, Scan, Add Page(s) from Scanner and all the Draw actions are interactive, therefore, we recommend that you do not use them in combination with other custom form actions.
  8. Click OK.

    The newly created action is added to the table.

  9. Click Save.
  10. Associate the action with the capture control that will trigger this action. Alternatively, if you wish to call the Web Capture action on load of a form then associate the action with the form. See Associate an action with a form or control.