Webservice-Konfiguration grafisch bearbeiten
Die Webservice-Konfiguration lässt sich im X4 Designer über den grafischen Webservice Configuration Editor bearbeiten und im X4 Server aktualisieren. Technical Processes können so mit wenigen Mausklicks als OpenAPI-basierte Webservices bereitgestellt werden.
Alle Webservices, die auf diesem Weg bereitgestellt werden, besitzen eine einheitliche Basis-URL. Die Basis-URL ist standardmäßig http://localhost:8080/X4/httpstarter/ReST.
Webservice Configuration Editor aufrufen
Um den Webservice Configuration Editor aufzurufen, doppelklicken Sie in der Sicht Projects auf die .wsinc-Datei.
Oberfläche des Webservice Configuration Editors
Der Webservice Configuration Editor ist in folgende Bereiche unterteilt:
Tree: URL-Baumstruktur
Im Bereich Tree wird die hierarchische Webservice-URL-Struktur bzw. werden die URL-Parts in einer auf- und zuklappbaren Baumstruktur angezeigt. Diese Baumstruktur können Sie per Rechtsklick über das Kontextmenü bearbeiten. Zudem können Sie Elemente innerhalb des Baums per Drag&Drop verschieben.
Über das Feld Filter können Sie die angezeigte Baumstruktur anhand des Knotennamens filtern, sodass Strukturen, die das Suchwort nicht enthalten, ausgeblendet werden. Über 
File, HTTP ReST und SOAP auch anhand des Service-Typs gefiltert werden.
Baumelemente
| Konstanter URL-Part Sämtliche Eigenschaften der ausgewählten Konstante können Sie im Bereich Scope definieren oder Sicherheitseigenschaften vom übergeordneten Element erben lassen. |
| Variabler URL-Part Sämtliche Eigenschaften zur ausgewählten Variable können Sie im Bereich Scope definieren oder Sicherheitseigenschaften vom übergeordneten Element erben lassen. |
| Komplett beliebige URL-Part-Definition Sämtliche Eigenschaften zum ausgewählten Remainder können Sie im Bereich Scope definieren oder Sicherheitseigenschaften vom übergeordneten Element erben lassen. |
Konstanten, Variablen oder Remainder erstellen und verwalten
Markieren Sie in der Baumstruktur den gewünschten Knoten (entspricht einem URL-Part des Webservices), klicken Sie mit der rechten Maustaste darauf, und wählen Sie im Kontextmenü eine Aktion:
Add Constant | Konstante als Kindknoten anlegen, um einen konstanten URL-Part für Ihren Webservice zu definieren |
Add Variable | Variable als Kindknoten anlegen, um mit Platzhaltern variable Bestandteile innerhalb der URL Ihres Webservices zu definieren |
Add Remainder | Remainder als Kindknoten anlegen, um alle restlichen URL-Parts abzufangen |
Copy Service URL to Clipboard | Zugehörige Webservice-Ressourcen-URL in die Zwischenablage kopieren |
Rename | Markierten Knoten umbenennen |
Delete | Markierten Knoten löschen |
Bei den Knotennamen wird zwischen Groß- und Kleinschreibung unterschieden!
Sicherheitseigenschaften des Knotens definieren
Für den ausgewählten Knoten können Sie in Access Restrictions bei Bedarf (Sicherheits-)Eigenschaften definieren.
Mit Inherit from parent node wird der Sicherheitsbereich vom übergeordneten Element übernommen. Deaktivieren Sie diese Eigenschaft, um einen benutzerdefinierten Wert zu setzen.
Realm | Sicherheitsbereich für den aktuellen URL-Part | |
Client ID | Keycloak-Client | |
Client Secret | Keycloak-Client-Anmeldedaten | |
Access Role | Keycloak-Role Die Role muss in Keycloak dem Benutzer zugewiesen werden, um Zugang zum Webservice zu erhalten. | |
Guest Allowed | Wenn ein Sicherheitsbereich in Eigenschaft | |
Token Return | Zurückgegebenes Log-in-Token auswählen Mögliche Werte:
| |
Login Failure Return | In Kombination mit dem Log-in-Modul für X4 Web Apps können Sie mit Login Failure Return steuern, ob nach einem gescheiterten Anmeldeversuch auch der Grund zurückgegeben werden soll. Mögliche Werte:
| |