WebService.Url[](*)

Base address in the form of a URL (including port number, but without any further path), under which the web services are called up

It is possible to specify multiple alternative addresses (e.g., for "localhost" and the server name). Using * for the server name implicitly binds the services to all IP addresses.

Mixed operation of HTTP and HTTPS addresses is not supported. When using HTTPS, always add the appropriate certificate of type Certificates[].Usage: "Server" to your specification. Regardless of which server name or server address is defined in the configuration, always specify the server name in the calling client such that it matches the name in the certificate.

The usability of the insecure HTTP protocol is limited to the localhost address. This means that the web services can be tested locally on the server, even if no certificate is available yet. A secure HTTPS connection is required for productive operation.

If a URL is not defined, all web services will remain inactive.

WebService.UrlBasePath

Additional URL base path portion that precedes the paths of all web services

To dispense with a path prefix, an empty string ("") can be specified for this property in deviation from the standard, without the default value taking effect. To prevent the default value from taking effect, also make sure to omit the entire property name.

In principle, URLs can also be called up if the base path is omitted despite being configured. However, this is only possible if the xSuite Helix Proxy is not active (see xSuite Helix Proxy). The xSuite Helix Proxy uses the base path to differentiate whether a request should be passed on to an internal service or be processed by the proxy itself.

Default value: /xSuite/Interface

WebService.WebRootFolder

Physical path of the base folder with the static web files (.html, .js, etc.)

Default value: WebRoot (relative path)

The static web files are used for the GUI applications (e.g., for the Configurator and the Status Monitor). The folder is made available in program installation and has the default name WebRoot. The names of the subfolders correspond to the individual web applications. These names are fixed and must not be changed.

By default, the web files in the subfolders are packed in a ZIP file. Optionally, the contents of the ZIP file in the respective folder can also be unpacked manually, such that the web server delivers these unpacked files. This procedure can be helpful if certain files are to be adapted or supplemented in terms of content (e.g., template files for the Configurator).

WebService.AuthMode

Type of authentication against the web services:

If, in the context of the specific configuration of individual web services, you are specifying the names of users who are to be granted access to these services (.AllowUser property), make your specifications according to the authentication method selected:

WebService.BasicAuthUser[].Name(*)

WebService.BasicAuthUser[].PasswordHash(*)

Pairs of user names and passwords for defining valid logins when using authentication Basic

The passwords are not stored in their complete forms, but as (salted) hashes.

To generate this kind of value for a password, use the Config Web Service (see property ConfigService.Activate).

WebService.ApiKey[].Name(*)

WebService.ApiKey[].KeyHash(*)

Pairs of API key names and their values for defining valid logins when using authentication ApiKey

These are to be configured in the same way as the WebService.BasicAuthUser[] property is.

The names are only used to identify the keys when used in .AllowUser[]. The identifier of the API key to be specified in the HTTP call is defined in .ApiKeyName.