Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Config-Webservice

Der Config-Webservice implementiert die Back-End-Dienste für die grafische Benutzeroberfläche des Konfigurators. Außerdem bietet der Config-Webservice einige API-Methoden.

Konfigurator

Für die Nutzung der grafischen Benutzeroberfläche des Konfigurators muss der Config-Webservice und die Auslieferung statischer Web-Dateien (Eigenschaft WebService.Web­RootFolder) aktiviert sein. Wenn die notwendigen Zugriffsrechte (Eigen­schaft ConfigService.AllowUser) gesetzt sind, ist der Konfigurator über die folgende URL aufrufbar:

{Basisadresse}/{Basispfad}/Config

Weitere Informationen zum Konfigurator finden Sie unter Konfigurator.

Maskendesigner

Der Maskendesigner ist eine eigenständige Unteranwendung des Konfigurators. Der Maskendesigner kann genutzt werden, um Indexierungsmasken für den Office+ Index Client (siehe Eingabesystem "WebServiceIndexClient") zu erstellen. Die Aktivierung der grafischen Benutzeroberfläche und die Zugriffsrechte für den Maskendesigner sind an den Config-Webservice gekoppelt, d.h. die Konfigurationseigenschaften des Config-Webservices gelten implizit auch für den Maskendesigner. Der Aufruf des Maskendesigners erfolgt über die folgende URL:

{Basisadresse}/{Basispfad}/Config/MaskDesigner

Weitere Informationen zum Maskendesigner finden Sie unter Maskendesigner.

Eigenschaften

Eigenschaft

Beschreibung

ConfigService.Activate

Wahrheitswert, ob der Config-Webservice aktiviert ist

Standardwert: FALSE

ConfigService.AllowUser[]

Definition von Benutzerrechten zum Aufruf des Config-Webservices

Jeder Eintrag setzt sich aus den folgenden Einzelparametern zusammen:

  1. Name*: Name des betreffenden Benutzers (Syntax: siehe WebService.AuthMode)

  2. Rights: Rechte des Benutzers

Der Parameter Rights besteht aus einer zusammengesetzten Zeichenfolge. Die folgenden Werte sind zulässig:

  • R (Read): Anzeige von Daten

  • E (Edit): Bearbeitung von Daten

  • D (Delete): Löschen von Daten

  • J (JSON): Anzeige interner JSON-Daten

Wenn in einem Eintrag keine einschränkenden Rechte definiert sind, erhält der Benutzer implizit alle Rechte. Wenn gar keine Benutzerrechte definiert sind, erhält jeder Benutzer vollen Zugriff. Sobald aber Rechte definiert sind, erhalten nur noch explizit dort aufgeführte Benutzer Zugriff.

ConfigService.AllowGroup[]

Definition von Rechten für Benutzergruppen zum Aufruf des Config-Webservices

Diese Eigenschaft ist nur relevant, wenn die Windows-Authentifizierung aktiviert ist, da ausschließlich Gruppen aus einem Windows Active Directory unterstützt werden. Der Gruppenname muss als erster Parameter in der Syntax Domäne\Gruppenname angegeben werden.

ConfigService.MaxBackupCount

maximale Anzahl vorzuhaltender Sicherungsdateien

Bei der Nutzung des Konfigurators werden rollierende Backups der Konfigurationen im Dateisystem oder in der Datenbank erstellt, die gespeichert oder gelöscht werden sollen. In dieser Eigenschaft wird die maximale Anzahl der vorzuhaltenden Sicherungen definiert, bevor diese Dateien überschrieben werden. Das Überschreiben beginnt bei der ältesten Datei.

Wenn der Wert 0 ist, werden keine Backups erzeugt.

Standardwert: 3

ConfigService.IndexMaskFolder[]

ConfigService.ResourceFolder[]

Verzeichnisse, in denen Indexierungsmasken und zusätzliche Ressourcen-Dateien abgelegt sind

Der Maskendesigner ist unabhängig von aktivierten Szenarien aufrufbar. Aus diesem Grund müssen die Ablageorte der Indexierungsmasken, die von dem Maskendesigner bearbeitet werden sollen, an dieser Stelle separat definiert werden. In der Benutzeroberfläche des Maskendesigners werden diese Ablageorte als Quelle und Ziel zum Öffnen und Speichern von Masken angeboten.

Diese Eigenschaften sind nur bei der der Nutzung des Maskendesigners relevant.

ConfigService.ActivateMaskPreview

Wahrheitswert, ob im Maskendesigner eine Vorschauansicht aufrufbar ist

Die Vorschauansicht zeigt die Indexierungsmasken, die sich aktuell in Bearbeitung befinden.

Für die Vorschauansicht wird eine laufende Instanz des Back-End-Dienstes des Office+ Index Clients benötigt. Standardmäßig ist dieser Back-End-Dienst nur aktiv, wenn ein Szenario mit dem Eingabesystem "WebServiceIndexClient" aktiv ist. Über diese Eigenschaft kann der Service auch unabhängig von einem solchen Szenario explizit gestartet werden.

Standardwert: FALSE

API-Methoden

Hinweis

Die API-Methoden existieren hauptsächlich, weil in einer früheren Programmversion noch keine Benutzeroberfläche zur Konfiguration verfügbar war.

In der aktuellen Programmversion sind die Funktionalitäten dieser API-Methoden in die Benutzeroberfläche des Konfigurators integriert.

Der Config-Webservice verfügt über die folgenden API-Methoden:

Methode

Beschreibung

GET /api/v1/Config/Password/Encrypt?password={Klartext-Passwort} [EncryptPassword]

Verschlüsselung eines Klartext-Passworts

Für die Verwendung als Konfigurationswert ist der Rückgabewert in <§>…</§> einzubetten. In der Konfiguration muss dasselbe Zertifikat vom Typ Certificate[].Usage: "Crypt" aktiv sein, das zur Laufzeit auch für die Entschlüsselung genutzt wird.

GET /api/v1/Config/Password/Hash?password={Klartext-Passwort} [HashPassword]

Hashen eines Klartext-Passwortes

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

Generierung eines neuen API-Schlüssel

Liefert diesen Schlüssel und dessen Hash-Wert zurück.

In diesem Abschnitt: