3 Integrating the Client With Other Web Applications

This chapter discusses how to configure the client to launch from another web application.

The web application invokes the client via a web address. Parameters such as the workspace, capture source, client profile, document profile, and optional metadata values are passed within the address.

For example, you might add a Scan button to a line of business web application. After completing business application entry fields, the user clicks Scan. The client window displays to the user and Capture immediately begins scanning a document using a specified scanner and settings in the client profile specified in the web address. Once scanned, the document is displayed in the document pane. Metadata fields are automatically populated with user entries, which were passed in the web address. The user reviews the document and completes other metadata fields, then releases the batch, scans additional batches, or closes the browser. Upon close, the user returns to the line of business web application.

3.1 Configuring a Client Integration

To configure an integration between a web application and the Capture client:

  1. In the web application, add a launching point, such as a Scan button, from which to activate the client.

  2. Configure the web address and its parameters.

    Parameters are listed and described in Table 3-1.

    See the example integration configuration in Section 3.1.1.

  3. If needed, configure Single Sign-on (SSO) to prevent users from having to sign in to Capture before beginning scanning.

    Table 3-1 Client Integration URL Parameters

    Parameter Description

    CaptureWorkspace

    Specifies the workspace to which to capture documents.

    ClientProfile

    Optionally specifies the client profile with which to capture documents. If you specify a profile, the Client Profile field does not display in the client's batch pane. If no profile is specified, the client uses the client profile that was last used by the user on the system.

    CaptureDriver

    Specifies the driver to use to capture documents.

    • For importing, specify CAPTURE_IMPORT_DRIVER.

    • For TWAIN scanning, specify CAPTURE_TWAIN_DRIVER.

    If neither driver ID or source name are specified, the last used driver and source are used.

    CaptureSource

    Specify the source to use to capture documents, based on the selected CaptureDriver.

    • For importing, specify Import Source.

    • For TWAIN scanning, specify the scanner name. This is the same scanner name as identified in the client's Capture Source options.

    If neither driver ID or source name are specified, the client uses the driver and source that were last used by the user on the system.

    SignOutOnRelease

    Specify whether the business user is signed out of Capture after releasing a batch.

    • If you specify false or 0 (default), the user remains signed in after releasing a batch by clicking the Release icon.

    • If you specify true or 1, the user is signed out after a batch is released and the SignOutAction is performed, if specified.

    SignOutAction

    Specifies the action that occurs after the user is signed out.

    • If you specify CloseBrowser, the browser is closed and the user returns to the web application.

      Note that SignOutAction and CloseBrowser options function in Internet Explorer. In Firefox, they function if the client integration was launched via JavaScript.

    • If you specify a URL, the window is redirected to the specified URL.

    ShowAllBatches

    Specifies if batches display in a list to client users in the batch pane.

    • If you specify false or 0 (default), the batch list is initially empty and only shows batches scanned during the session.

    • If you specify true or 1, the batch list shows all the batches the user is allowed to see.

    DocumentProfile

    Specifies the document profile for users to use to index documents.

    • If you specify a document profile, the Document Profile field does not display in the client's metadata pane.

    • If no profile is specified, the client uses the document profile that was last used by the user on the system.

    Other

    Any other characters included in the URL are assumed to be a metadata names and values.

3.1.1 Example Client Integration Web Address

Here is an example URL. (Note that this URL should be all on one line.)

http://svr-capture:16400/dc-client/faces/dc-client?CaptureWorkspace=Accounting&ClientProfile=Import%20Invoices&CaptureDriver=CAPTURE_IMPORT_DRIVER&CaptureSource=Import%20Source&SignOutOnRelease=1&SignOutAction=CloseBrowser&Company=MyCompany&Dept=Accounting

This web address configures the client integration as follows:

  • CaptureWorkspace=Accounting - Specifies Accounting as the workspace to which to capture documents.

  • ClientProfile=Import Invoices - Specifies Import Invoices as the client profile to use.

  • CaptureDriver=CAPTURE_IMPORT_DRIVER - Specifies importing CAPTURE_IMPORT_DRIVER as the capture source rather than scanning.

  • CaptureSource=Import Source - Specifies Import Source as the capture source.

  • SignOutOnRelease=1&SignOutAction=CloseBrowser - 1&SignOutAction=CloseBrowser specifies that the user is signed out after releasing a batch and the browser closes.

  • Company=MyCompany - Passes a value of MyCompany for the Company metadata field.

  • Dept=Accounting - Passes a value of Accounting for the Dept metadata field.