Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Input System "WebServiceIndexClient"

The input system "WebServiceIndexClient" is the interactive web application Office+ Index Client.

To use the Index Client, define a scenario with "WebServiceIndexClient" as the input system, and, for its front end, activate delivery of static web files (property WebService.WebRootFolder property in global configuration). When the necessary access rights (ConfigService.AllowUser property) have been set, the Index Client can be accessed via the following URL:

{Base address}/{Base path}/IndexClient

For more information on the Index Client and other call parameters for the URL, see Office+ Index Client.

For the configuration of this input system, two sets of properties apply: the general configuration properties for web service interfaces (see Web Service Interfaces) and the properties listed below.

Notice

The file attachments are extracted from the transmitted data directly in the input system. The index values should preferably be read via the "WebService" index data reader in the "Process" step.

Property

Description

InputSystem.IndexMaskFolder*

Folder path in which the mask definitions are stored

These mask definitions are offered to the user for indexing the documents in the Index Client. The mask definitions are created via the Mask Designer.

InputSystem.ResourceFolder

Path of a folder for storing any additional resource files (optional)

The resource files (e.g. background images) are referenced from the masks.

InputSystem.ScanServiceUrl

HTTP(S) base address and port number of the scan web service running locally on the client

This property informs the web application of the address where the local web service can be reached. The value must match the URL key in the local configuration file of this web service. You can create an address of your own by appending the system variable %USER% as the URL path (e.g., http://localhost:22926/%USER%). This will allow the web service instances running in parallel to be addressed individually in multi-user operation.

This property only applies when using the additional component "Web Scan."