Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Office+ Index Client

The Office+ Index Client is a web-based user interface which, in conjunction with the "WebServiceIndexClient" input system, enables the manual indexing of document files stored locally by a user. The indexed files are then transferred as input data to an xSuite Interface scenario for continued processing.

Calling the Office+ Index Client

The address for calling the index client depends on the specific configuration (see Web Services) and ends with the fixed URL path /IndexClient:

{Base address}/{Base path}/IndexClient

The following URL parameters can also be specified in the address:

Parameter

Description

Tenant

Name of the tenant which is the context for processing to take place

Default value if omitted: Default

Scenario

Name of the scenario to be processed

The input system "WebServiceIndexClient" in this scenario defines the storage location of the indexing masks that are offered to the user. The parameter may only be omitted if only a single scenario with this input system is active in the relevant program instance of xSuite Interface, which is then used by default.

MaskName

Name of an indexing mask (optional)

The indexing mask is selected automatically so that the user does not have to make a manual selection.

Develop

When set to true, a mode is activated displaying additional buttons.

The additional buttons enable the display of internal data structures.

This mode primarily serves the purposes of development and error analysis.

A call with additional parameters might look like the following example:

. ../IndexClient?Tenant=Test client&Scenario=Test scenario