Integrating the Client With Other Web Applications

2 Integrating the Client With Other Web Applications

This chapter discusses how a web application can launch and communicate with the Capture Client.

The web application invokes the Capture Client through a Uniform Resource Locator (URL). Parameters such as the workspace, capture source, client profile, document profile, and optional metadata values are passed within the URL.

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 Capture 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 URL. After scanning, the document is displayed in the document pane. Metadata fields are automatically populated with user entries, which were passed in the URL. The user reviews the document and completes other metadata fields, then releases the batch, scans additional batches, or closes the Capture Client.

When a web application launches the URL, the Capture Client starts and prompts the user to log in. After logged in, the Capture Client uses the parameters, accordingly. If the Capture Client is already running when a web application launches the URL, the parameters will be passed to the already running instance of the Capture Client.

2.1 Configuring a Client Integration

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

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

Configure the URL and its parameters.

Parameters are listed and described in Table 2-1.

See the example integration configuration in Example Client Integration Web Address.

Note:

In 12c and 14c, client users always have to login to the Capture Client because the Client does not run within a browser.

Table 2-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 button. If you specify `true` or `1`, the user is signed out after a batch is released.
SignOutOnClose	Specify whether the user is signed out of Capture after closing the window. This setting governs whether user will be signed out or not when the Capture client is closed. If you specify `false` or `0`, the user remains signed in the browser application (from where the capture client was launched) after closing the Capture client window. If you specify `true` or `1` (default), the user is signed out by redirecting the user to the logout URL in the browser application (from where the capture client was launched).
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. When specifying date values for Capture metadata fields having a Field Type as Date, the date must be in the Coordinated Universal Time (UTC) format, yyyy-MM-ddTHH:mm:ssZ.

2.1.1 Example Client Integration URL

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

oraclecapture://CaptureWorkspace=Accounting&ClientProfile=Import%20Invoices&CaptureDriver=CAPTURE_IMPORT_DRIVER&CaptureSource=Import%20Source&SignOutOnRelease=1&Company=MyCompany&Dept=Accounting&Invoice%20Date=2015-08-04T12:00:00Z

This URL 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 CAPTURE_IMPORT_DRIVER as the capture source for importing.
CaptureSource=Import Source - Specifies Import Source as the capture source.
SignOutOnRelease=1 - Specifies that the user is signed out after releasing a batch.
Company=MyCompany - Passes a value of MyCompany for the Company metadata field.
Dept=Accounting - Passes a value of Accounting for the Dept metadata field.
Invoice%20Date=2015-08-04T12:00:00Z - Passes a date and time value as August 4, 2015 at 12 noon UTC time for the Invoice Date metadata field.