Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

The Mask Designer

The purpose of the Mask Designer is to define indexing masks. Indexing masks are part of Index Client functionality. You can go to the web application and use the masks to index documents. Once you have completed the indexing process, the documents will be transferred to an xSuite Interface scenario for further processing, via the "WebServiceIndexClient" input system.

Notice

Newly created indexing masks will be saved in JSON format. Indexing masks from xSuite Interface 4 are available in XML format, but can still be imported to the Mask Designer. When they are saved again, they will be automatically converted to JSON format. The old XML file will be renamed to .old.

Before the old masks from xSuite Interface 4 can be run in the current Index Client, though, most of them will require pre-processing. The Mask Designer will attempt to automate some small adjustments when loading an old mask. However, in and of themselves, the macro expressions used for formatting field content and setting field/mask properties are incompatible with old masks.

The Index Client uses the same macro interpreter as the main program. Since xSuite Interface 4, the range of functions, the naming of macro functions, and some syntactical details of the Index Client have changed, requiring certain macro expressions to be redefined. The main program's partially modified syntax also applies to the connection strings for accessing external data sources. Therefore, depending on the system to be addressed, you might have to adapt these connection strings as well. This will also involve a new syntax for storing encrypted passwords.

Calling the Mask Designer

The Mask Designer is activated implicitly together with the Configurator. The address for calling up the mask designer ends with the fixed URL path /Config/MaskDesigner:

{Base address}/{Base path}/Config/MaskDesigner

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

Parameter

Description

ExpertMode

Activates expert mode when set to true.

Additional buttons are available in expert mode, enabling display of internal data structures (e.g., the internal JSON representation of the current mask definition as it is saved by the program).

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

Mask

Transfers the technical name of a mask definition.

The mask definition specified will automatically pop up when the application is started.

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

. ../Config/MaskDesigner?ExpertMode=true&Mask=TestMask