Allgemeine Eigenschaften

Eigenschaft	Beschreibung
WebService.Url[](*)	Basisadresse in Form einer URL (inkl. Portnummer, aber ohne weiteren Pfad), unter der die Webservices aufgerufen werden Die Angabe mehrerer alternativer Adressen ist möglich, z. B. für "localhost" und den Servernamen. Mit `*` für den Servernamen werden die Services implizit an alle IP-Adressen gebunden. Ein Mischbetrieb von HTTP- und HTTPS-Adressen wird nicht unterstützt. Bei Nutzung von HTTPS ist zusätzlich ein entsprechendes Zertifikat des Typs `Certificates[].Usage: "Server"` anzugeben. Unabhängig davon, welcher Servername oder welche Serveradresse in der Konfiguration definiert ist, muss im aufrufenden Client der Servername so angegeben werden, dass dieser mit dem Namen im Zertifikat übereinstimmt. Die Verwendbarkeit des unsicheren HTTP-Protokolls ist beschränkt auf die `localhost`-Adresse. Somit können die Webservices lokal am Server getestet werden, auch wenn noch kein Zertifikat verfügbar ist. Für den produktiven Betrieb ist eine sichere HTTPS-Verbindung notwendig. Wenn keine URL definiert ist, bleiben alle Webservices inaktiv. Hinweis Die Webservices sind nur aufrufbar, wenn das Programm mit lokalen Administratorrechten gestartet wird. Wenn die Webservices aktiviert sind, aber das Programm ohne lokale Administratorrechte gestartet wird, funktioniert die Bindung an den Port nicht und die Webservices sind nicht aufrufbar. Beim Programmstart wird eine entsprechende Fehlermeldung im Log ausgegeben.
WebService.UrlBasePath	zusätzlicher URL-Basispfadanteil, der den Pfaden aller Webservices vorangestellt wird Um auf einen Pfad-Präfix zu verzichten, kann für diese Eigenschaft abweichend vom Standard eine leere Zeichenfolge (`""`) angegeben werden, ohne dass der Standardwert greift. Damit der Standardwert nicht greift, muss auch der Eigenschaftsname komplett weggelassen werden. Prinzipiell sind URLs trotz konfigurierten Basispfades auch bei dessen Weglassung aufrufbar. Dies ist allerdings nur möglich, wenn der xSuite Helix Proxy nicht aktiv ist (siehe xSuite Helix Proxy). Der xSuite Helix Proxy nutzt den Basispfad zur Unterscheidung, ob eine Anfrage an einen internen Service durchgereicht oder vom Proxy selbst verarbeitet werden soll. Standardwert: `/xSuite/Interface`
WebService.WebRootFolder	physischer Pfad des Basisordners mit den statischen Web-Dateien (`.html`, `.js`, etc.) Standardwert: `WebRoot` (relativer Pfad) Die statischen Web-Dateien werden für die GUI-Anwendungen verwendet, z. B. für den Konfigurator und den Statusmonitor. Der Ordner ist Bestandteil der Programminstallation und hat standardmäßig den Namen `WebRoot`. Die Namen der Unterordner entsprechen den einzelnen Webanwendungen. Diese Namen sind fest vorgegeben und dürfen nicht geändert werden. Die Web-Dateien in den Unterordnern sind standardmäßig in einer ZIP-Datei verpackt. Optional kann der Inhalt der ZIP-Datei in dem jeweiligen Ordner auch manuell entpackt werden, sodass der Webserver diese entpackten Dateien ausliefert. Dieses Vorgehen kann hilfreich sein, wenn bestimmte Dateien inhaltlich angepasst oder ergänzt werden sollen, z. B. Vorlagendateien für den Konfigurator.
WebService.AuthMode	Art der Authentifizierung gegenüber den Webservices: `None`: keine Authentifizierung (Standardwert) `Windows`: NTLM-Authentifizierung mit Windows-Benutzer Hinweis Kerberos-Authentifizierung wird nicht unterstützt. `Basic`: Basisauthentifizierung mit Benutzername und Passwort `ApiKey`: API-Schlüssel `Certificate`: Client-Zertifikat Wenn im Kontext der spezifischen Konfiguration einzelner Webservices die Namen von Benutzern anzugeben sind, die Zugriff auf diese Services erhalten sollen (Eigenschaft `.AllowUser`), müssen abhängig vom genutzten Authentifizierungsverfahren unterschiedliche Angaben gemacht werden: `Windows`: `Domäne\Benutzername` `Basic`: Name, der in der Eigenschaft `.BasicAuthUser[].Name` definiert ist `ApiKey`: Name, der in der Eigenschaft `.ApiKey[].Name` definiert ist `Certificate`: Name, der im Zertifikat enthalten ist (im Windows-Zertifikatsmanager in der Regel die Eigenschaft Ausgestellt für) Hinweis Verwenden Sie nicht die Eigenschaft `.Certificate[].Name`. Hinweis Die Windows-Authentifizierung wird nur eingeschränkt unterstützt. Die Implementierung dieser Authentifizierung ist nicht mit allen Webbrowsern kompatibel oder setzt zusätzliche Konfigurationsarbeiten voraus. Für Mozilla Firefox muss die Windows-Authentifizierung in den Firefox-Einstellungen (`about:config`) aktiviert werden. Die folgenden Parameter müssen auf `true` gesetzt werden: `network.negotiate-auth.allow-non-fqdn` `network.automatic-ntlm-auth.allow-non-fqdn` Die folgenden Parameter müssen auf den Domnänennamen gesetzt werden: `network.negotiate-auth.trusted-uris` `network.automatic-ntlm-auth.trusted-uris` Für Microsoft Edge können administrative Tätigkeiten erforderlich sein. Dem Benutzerkonto, das xSuite Interface ausführt, müssen Dienstprinzipalnamen (SPNs) über das Kommando `setspn` hinzugefügt werden.
WebService.ApiKeyName	Name des Schlüssels im HTTP-Aufruf bei der Nutzung der Authentifizierung `ApiKey` Standardwert: `Bearer`
WebService.BasicAuthUser[].Name() WebService.BasicAuthUser[].PasswordHash()	Paare aus Benutzernamen und Passwörtern zur Definition gültiger Anmeldungen bei Nutzung der Authentifizierung `Basic` Die Passwörter werden nicht vollständig gespeichert, sondern als (Salted) Hashes. Um einen solchen Wert für ein Passwort zu generieren, muss der Config-Webservice genutzt werden (siehe Eigenschaft `ConfigService.Activate`).
WebService.ApiKey[].Name() WebService.ApiKey[].KeyHash()	Paare aus API-Schlüsselnamen und deren Werten zur Definition gültiger Anmeldungen bei Nutzung der Authentifizierung `ApiKey` Diese sind analog zur Eigenschaft `WebService.BasicAuthUser[]` zu konfigurieren. Die Namen dienen nur zur Identifikation der Schlüssel bei der Verwendung in `.AllowUser[]`. Der Bezeichner des API-Schlüssels, der im HTTP-Aufruf anzugeben ist, wird in `.ApiKeyName` definiert.
WebService.ActivateHomePage	Wahrheitswert, ob eine Startseite aufrufbar ist Die Startseite wird angezeigt, wenn im Webbrowser nur die Basisadresse und der Basispfad angegeben wird, ohne den Unterpfad für eine spezifische Anwendung: `{Basisadresse}/{Basispfad}` Standardwert: `TRUE`
WebService.HomePageAllowUser[] WebService.HomePageAllowGroup[]	optionale Auflistung der Namen von Benutzern oder Gruppen, die Zugriff auf die Startseite haben (analog zu den Eigenschaften unter Webservice-Schnittstellen)

Eigenschaft

Beschreibung

WebService.Url[](*)

Basisadresse in Form einer URL (inkl. Portnummer, aber ohne weiteren Pfad), unter der die Webservices aufgerufen werden

Die Angabe mehrerer alternativer Adressen ist möglich, z. B. für "localhost" und den Servernamen. Mit * für den Servernamen werden die Services implizit an alle IP-Adressen gebunden.

Ein Mischbetrieb von HTTP- und HTTPS-Adressen wird nicht unterstützt. Bei Nutzung von HTTPS ist zusätzlich ein entsprechendes Zertifikat des Typs Certificates[].Usage: "Server" anzugeben. Unabhängig davon, welcher Servername oder welche Serveradresse in der Konfiguration definiert ist, muss im aufrufenden Client der Servername so angegeben werden, dass dieser mit dem Namen im Zertifikat übereinstimmt.

Die Verwendbarkeit des unsicheren HTTP-Protokolls ist beschränkt auf die localhost-Adresse. Somit können die Webservices lokal am Server getestet werden, auch wenn noch kein Zertifikat verfügbar ist. Für den produktiven Betrieb ist eine sichere HTTPS-Verbindung notwendig.

Wenn keine URL definiert ist, bleiben alle Webservices inaktiv.

Hinweis

Die Webservices sind nur aufrufbar, wenn das Programm mit lokalen Administratorrechten gestartet wird. Wenn die Webservices aktiviert sind, aber das Programm ohne lokale Administratorrechte gestartet wird, funktioniert die Bindung an den Port nicht und die Webservices sind nicht aufrufbar. Beim Programmstart wird eine entsprechende Fehlermeldung im Log ausgegeben.

WebService.UrlBasePath

zusätzlicher URL-Basispfadanteil, der den Pfaden aller Webservices vorangestellt wird

Um auf einen Pfad-Präfix zu verzichten, kann für diese Eigenschaft abweichend vom Standard eine leere Zeichenfolge ("") angegeben werden, ohne dass der Standardwert greift. Damit der Standardwert nicht greift, muss auch der Eigenschaftsname komplett weggelassen werden.

Prinzipiell sind URLs trotz konfigurierten Basispfades auch bei dessen Weglassung aufrufbar. Dies ist allerdings nur möglich, wenn der xSuite Helix Proxy nicht aktiv ist (siehe xSuite Helix Proxy). Der xSuite Helix Proxy nutzt den Basispfad zur Unterscheidung, ob eine Anfrage an einen internen Service durchgereicht oder vom Proxy selbst verarbeitet werden soll.

Standardwert: /xSuite/Interface

WebService.WebRootFolder

physischer Pfad des Basisordners mit den statischen Web-Dateien (.html, .js, etc.)

Standardwert: WebRoot (relativer Pfad)

Die statischen Web-Dateien werden für die GUI-Anwendungen verwendet, z. B. für den Konfigurator und den Statusmonitor. Der Ordner ist Bestandteil der Programminstallation und hat standardmäßig den Namen WebRoot. Die Namen der Unterordner entsprechen den einzelnen Webanwendungen. Diese Namen sind fest vorgegeben und dürfen nicht geändert werden.

Die Web-Dateien in den Unterordnern sind standardmäßig in einer ZIP-Datei verpackt. Optional kann der Inhalt der ZIP-Datei in dem jeweiligen Ordner auch manuell entpackt werden, sodass der Webserver diese entpackten Dateien ausliefert. Dieses Vorgehen kann hilfreich sein, wenn bestimmte Dateien inhaltlich angepasst oder ergänzt werden sollen, z. B. Vorlagendateien für den Konfigurator.

WebService.AuthMode

Art der Authentifizierung gegenüber den Webservices:

None: keine Authentifizierung (Standardwert)
Windows: NTLM-Authentifizierung mit Windows-Benutzer
Hinweis
Kerberos-Authentifizierung wird nicht unterstützt.
Basic: Basisauthentifizierung mit Benutzername und Passwort
ApiKey: API-Schlüssel
Certificate: Client-Zertifikat

Wenn im Kontext der spezifischen Konfiguration einzelner Webservices die Namen von Benutzern anzugeben sind, die Zugriff auf diese Services erhalten sollen (Eigenschaft .AllowUser), müssen abhängig vom genutzten Authentifizierungsverfahren unterschiedliche Angaben gemacht werden:

Windows: Domäne\Benutzername
Basic: Name, der in der Eigenschaft .BasicAuthUser[].Name definiert ist
ApiKey: Name, der in der Eigenschaft .ApiKey[].Name definiert ist
Certificate: Name, der im Zertifikat enthalten ist (im Windows-Zertifikatsmanager in der Regel die Eigenschaft Ausgestellt für)
Hinweis
Verwenden Sie nicht die Eigenschaft .Certificate[].Name.

Hinweis

Die Windows-Authentifizierung wird nur eingeschränkt unterstützt. Die Implementierung dieser Authentifizierung ist nicht mit allen Webbrowsern kompatibel oder setzt zusätzliche Konfigurationsarbeiten voraus.

Für Mozilla Firefox muss die Windows-Authentifizierung in den Firefox-Einstellungen (about:config) aktiviert werden. Die folgenden Parameter müssen auf true gesetzt werden:

network.negotiate-auth.allow-non-fqdn
network.automatic-ntlm-auth.allow-non-fqdn

Die folgenden Parameter müssen auf den Domnänennamen gesetzt werden:

network.negotiate-auth.trusted-uris
network.automatic-ntlm-auth.trusted-uris

Für Microsoft Edge können administrative Tätigkeiten erforderlich sein. Dem Benutzerkonto, das xSuite Interface ausführt, müssen Dienstprinzipalnamen (SPNs) über das Kommando setspn hinzugefügt werden.

WebService.ApiKeyName

Name des Schlüssels im HTTP-Aufruf bei der Nutzung der Authentifizierung ApiKey

Standardwert: Bearer

WebService.BasicAuthUser[].Name(*)

WebService.BasicAuthUser[].PasswordHash(*)

Paare aus Benutzernamen und Passwörtern zur Definition gültiger Anmeldungen bei Nutzung der Authentifizierung Basic

Die Passwörter werden nicht vollständig gespeichert, sondern als (Salted) Hashes.

Um einen solchen Wert für ein Passwort zu generieren, muss der Config-Webservice genutzt werden (siehe Eigenschaft ConfigService.Activate).

WebService.ApiKey[].Name(*)

WebService.ApiKey[].KeyHash(*)

Paare aus API-Schlüsselnamen und deren Werten zur Definition gültiger Anmeldungen bei Nutzung der Authentifizierung ApiKey

Diese sind analog zur Eigenschaft WebService.BasicAuthUser[] zu konfigurieren.

Die Namen dienen nur zur Identifikation der Schlüssel bei der Verwendung in .AllowUser[]. Der Bezeichner des API-Schlüssels, der im HTTP-Aufruf anzugeben ist, wird in .ApiKeyName definiert.

WebService.ActivateHomePage

Wahrheitswert, ob eine Startseite aufrufbar ist

Die Startseite wird angezeigt, wenn im Webbrowser nur die Basisadresse und der Basispfad angegeben wird, ohne den Unterpfad für eine spezifische Anwendung: {Basisadresse}/{Basispfad}

Standardwert: TRUE

WebService.HomePageAllowUser[]

WebService.HomePageAllowGroup[]

optionale Auflistung der Namen von Benutzern oder Gruppen, die Zugriff auf die Startseite haben (analog zu den Eigenschaften unter Webservice-Schnittstellen)

In diesem Abschnitt:

xSuite Interface Windows Prism 5.x – Online-Hilfe