Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Config Web Service

The Config Web Service implements the back-end services for the graphical user interface of the Configurator. The Config Web Service also offers some API methods.

The Configurator

To use the graphical user interface of the Configurator, the Config Web Service and the delivery of static web files (property WebService.WebRootFolder) must be activated. When the necessary access rights (ConfigService.AllowUser property) are set, the Configurator can be accessed via the following URL:

{Base address}/{Base path}/Config

For more information on the Configurator, see The Configurator.

The Mask Designer

The Mask Designer is an independent sub-application of the Configurator. You can use the Mask Designer to create indexing masks for the Office+ Index Client (see Input System "WebServiceIndexClient"). The activation of the graphical user interface and the access rights for the Mask Designer are linked to the Config Web Service (i.e., the configuration properties of the Config Web Service also apply implicitly to the Mask Designer). Call up the Mask Designer via the following URL:

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

For more information on the Mask Designer, see The Mask Designer.

Properties

Property

Description

ConfigService.Activate

Boolean value determining whether the Config Web Service is enabled

Default value: TRUE

ConfigService.AllowUser[]

Definition of user rights to call the Config Web Service

Each entry is composed of the following individual parameters:

  1. Name*: name of the relevant user (syntax: see WebService.AuthMode)

  2. Rights: user permissions

The Rights parameter consists of a composite string. The following values are permitted:

  • R (Read): for displaying data

  • E (Edit): for editing data

  • D (Delete): for deleting data

  • J (JSON): for displaying internal JSON data

If no restrictive rights are defined in an entry, the user will implicitly receive all rights. If no user rights are defined at all, every user will receive full access, but as soon as rights are defined, only users explicitly listed there will have access.

ConfigService.AllowGroup[]

Definition of user group rights to call the Config Web Service

This property is only relevant if Windows authentication is activated, as only groups from a Windows Active Directory are supported. Specify the group name as the first parameter in the syntax domain\group name.

ConfigService.MaxBackupCount

Maximum number of backup files to be kept

The Configurator creates backups of configuration files to be saved or deleted, on a rolling basis during use. This property defines the maximum number of backup files to be kept before these files are overwritten. The process of overwriting starts with the oldest file.

If the value is 0, no backups will be created at all.

Default value: 3

ConfigService.IndexMaskFolder[]

ConfigService.ResourceFolder[]

Directories in which indexing masks and additional resource files are stored

The Mask Designer can be called up independent of activated scenarios. For this reason, the storage locations of the indexing masks that are to be edited by the Mask Designer must be defined separately at this point. In the user interface of the Mask Designer, these storage locations are offered as the source and target for opening and saving masks.

These properties are only relevant when using the Mask Designer.

ConfigService.ActivateMaskPreview

Boolean value determining whether a preview view can be called up in the Mask Designer

The preview view shows the indexing masks that are currently being edited.

A running instance of the Office+ Index Client back-end service is required for the preview view. By default, this back-end service is only active if a scenario with the "WebServiceIndexClient" input system is active. This property can also be used to explicitly start the service, independently of such a scenario.

Default value: TRUE

API Methods

Notice

The API methods exist mainly because no user interface for configuration was available in an earlier program version.

In the current version of the program, the functionalities of these API methods are integrated into the user interface of the Configurator.

The Config Web Service has the following API methods:

Method

Description

GET /api/v1/Config/Password/Encrypt?password={PlaintextPassword} [EncryptPassword]

Encryption of a plaintext password

For use as a configuration value, embed the return value in <§>...</§ >. The same certificate of type Certificate[].Usage: "Crypt" must be active in the configuration that is also used for decryption at runtime.

GET /api/v1/Config/Password/Hash?password={PlaintextPassword} [HashPassword]

Hashing a plaintext password

GET /api/v1/Config/ApiKey [CreateApiKey]

Generation of a new API key

Returns this key and its hash value.

In this section: