Die Dokumentation ab Version 39.5.17 von PLANTA project finden Sie in der neuen PLANTA Online-Hilfe

Web-Schnittstellen MOD009CRT Neu ab DB 39.5.10

Bei Einsatz von Web-Schnittstellen bitte ein bekanntes Problem nach Updates beachten.

Einstieg

Rolle PLANTA link Web-Schnittstellen Panel Konfiguration Web-Schnittstellen

Informationen

In diesem Modul werden Web-Schnittstellen angelegt und konfiguriert.
Eine Web-Schnittstelle definiert den Endpunkt, an dem mit PLANTA interagiert werden kann.
Pro Methode (GET, PUT, POST, DELETE) können eine Implementation und eine Web-Entität hinterlegt werden.
- Die Implementation gibt vor, wie sich die Schnittstelle verhalten soll, wenn sie aufgerufen wird.
- Die Web-Entität beschreibt die Daten, mit denen die Schnittstelle interagiert.
Über das Kontextmenü einer Web-Schnittstelle werden mit dem Befehl Web-Entitäten bearbeiten die Web-Entitäten im Modul Web-Entitäten zur Bearbeitung aufgerufen, die mit dieser Web-Schnittstelle konfiguriert wurden.

Hinweise

Ab DB 39.5.14

Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices in der web.conf aktiviert und konfiguriert sein:
- generic_service = true
- generic_service_interface und generic_service_port enthalten sinnvolle Daten
Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.
NEU Web-Schnittstellen verwenden standardmäßig den Fully Qualified Domain Name (FQDN) als Adresse. Ist dieser nicht verfügbar, wird auf den Hostnamen der Maschine zurückgegriffen. Ist dieser nicht verfügbar, wird auf die IP der Maschine zurückgegriffen. Ein expliziter Hostname kann mit der Globalen Einstellung planta_link_hostname definiert werden.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices in der web.conf aktiviert und konfiguriert sein:
- generic_service = true
- generic_service_interface und generic_service_port enthalten sinnvolle Daten
- Das Makro 009CW6 wurde einmalig ausgeführt und der Dienst neugestartet.
Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices aktiviert und konfiguriert sein:
- generic_service = true
- Die Parameter generic_service_interface und generic_service_port enthalten sinnvolle Daten.
- Das Makro 009CW6 wurde einmalig ausgeführt und der Dienst neugestartet.
Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Siehe auch: Allgemeine Informationen zu Web-Schnittstellen; Web-Schnittstellen-Workflows: GET, PUT, POST, DELETE

Siehe auch: Allgemeine Informationen zu Web-Schnittstellen; Web-Schnittstellen-Workflows: GET, PUT, POST, DELETE

Vorgehensweise

Neue Web-Schnittstelle einfügen:
- Über den Kontextmenüeintrag Einfügen Web-Schnittstelle oder
- Klick auf den Button Einfügen
Felder im Kopfbereich wie folgt ausfüllen:
- Die Bezeichnung ist frei wählbar
- Das Feld Aktiv muss aktiviert werden, bevor die Schnittstelle eingesetzt wird.
- Im Feld Url einen Platzhalter anlegen, beispielsweise: /load/{resource}
- Einen API Schlüssel vergeben.
- Das Feld Log-Level gibt je nach Auswahl an, was geloggt werden soll.
- Die gewünschte GET-Implementation (oder PUT, POST, DELETE) auswählen.
- Die gewünschte Entität auswählen.
Speichern
Nach Auswahl der Entität kann mit einem Klick auf den Button der URL-Filter konfiguriert werden.
Über den Button kann die Schnittstelle im Modul Web-Schnittstellen testen getestet werden.

Vorgehensweise

Neue Web-Schnittstelle einfügen:
- Über den Kontextmenüeintrag Einfügen Web-Schnittstelle oder
- Klick auf den Button Einfügen
Felder im Kopfbereich wie folgt ausfüllen:
- Die Bezeichnung ist frei wählbar
- Das Feld Aktiv muss aktiviert werden, bevor die Schnittstelle eingesetzt wird.
- Im Feld Url einen Platzhalter anlegen, beispielsweise: /load/{resource}
- Einen API Schlüssel vergeben.
- Das Feld Log-Level gibt je nach Auswahl an, was geloggt werden soll.
- Die gewünschte GET-Implementation (oder PUT, POST, DELETE) auswählen.
- Die gewünschte Entität auswählen.
Speichern
Nach Auswahl der Entität kann mit einem Klick auf den Button der URL-Filter konfiguriert werden.
Über den Button kann die Schnittstelle im Modul Web-Schnittstellen testen getestet werden.

Vorgehensweise

Maske für Web-Schnittstellen einfügen:
- Über den Kontextmenüeintrag Einfügen Web-Schnittstelle oder
- Klick auf den Button Einfügen
In der Listbox UUID die gewünschte Web-Schnittstelle auswählen.
Die gewünschten Werte ändern.
Speichern.

Siehe auch: Hier finden Sie einen Überblick über alle PLANTA link-Inhalte

Siehe auch: Hier finden Sie einen Überblick über alle PLANTA link-Inhalte

Topic attachments
I	Attachment	History	Size	Date
png	ErdeButton.png	r1	0.9 K	2019-09-09 - 10:02
png	KonfigButton.png	r1	0.7 K	2019-09-09 - 10:02
png	TestButton.png	r1	0.5 K	2019-09-09 - 10:02
png	WerkzeugButton.png	r1	0.7 K	2019-09-09 - 10:03

PLANTA project

PLANTA pulse

PLANTA project