Web-Entitäten MOD009CRU

Einstieg

• Rolle PLANTA link → Web-Schnittstellen → Panel Konfiguration → Web-Entitäten

Informationen

• In diesem Modul werden Web-Entitäten konfiguriert und angelegt.
• Eine Web-Entität
  • beschreibt das Objekt, welches mit den Web-Schnittstellen interagiert (z.B. die Werte, die ein GET-Request zurückgibt).
  • hat eine Bezeichnung und zeigt auf eine Datentabelle.
  • hat n Web-Attribute, die auf jeweils ein Dataitem aus der Datentabelle zeigen.
    • Web-Attribute haben einen Namen und optional eine Transformerklasse, die den jeweiligen Wert transformiert.
• Über das Kontextmenü einer Entität werden über den Befehl zugeordnete Web-Schnittstellen bearbeiten alle Web-Schnittstellen im Modul Web-Schnittstellen zur Bearbeitung aufgerufen, die mit dieser Entität konfiguriert wurden.

Details

• Das Modul Web-Entitäten kann nicht geschlossen werden, solange es als Untermodul zur Web-Konfiguration geöffnet ist.

Hinweise

• 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.
• 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!

Neue Web-Entität anlegen

Vorgehensweise

• Neue Entität einfügen:
  • Über den Kontextmenüeintrag Einfügen → Web-Entität oder
  • Klick auf den Button Einfügen
• Bezeichnung vergeben
• Im Feld Datentabelle die gewünschte Tabelle auswählen.
• Über den Kontextmenüeintrag der neu erstellten Web-Entität Einfügen → Web-Attribut die gewünschten Web-Attribute einfügen
  • Die Spaltentypen werden automatisch ausgelesen und angezeigt.
  • Die Bezeichnung des Attributs im Feld Name ist frei wählbar, muss jedoch den Java-Namenskonventionen für Bezeichner folgen und darf innerhalb einer Entität nicht mehrfach vorkommen.
  • Für die ausgewählten Transformer besteht die Möglichkeit, durch Klick auf die Werkzeugschaltfläche Transfomer-Parameter konfigurieren das Dialogmodul Parameter konfigurieren zu öffnen, in dem die Parameter des ausgewählten Transformers angepasst werden können.
    • Für ein Datum wird im Feld Transformer automatisch DateTransformer ausgewählt. Der DateTransformer erlaubt es, das Datumsformat zu konfigurieren.
• Die Felder Muss-Feld PUT und Muss-Feld POST deklarieren ein Attribut als obligatorisch für einen PUT- bzw. POST-Request. Fehlt dieses Attribut im entsprechenden Request, schlägt der Request mit Statuscode 400 fehl.
  • Attribute können entweder nur als Muss-Feld PUT oder Muss-Feld POST, oder gleichzeitig als Muss-Feld PUT und Muss-Feld POST deklariert werden.
• Wird die Checkbox Schreibgeschützt bei einem Attribut aktiviert, so kann es gelesen aber nicht geschrieben werden.
• Speichern.

Hinweis

• Wenn ein zusätzliches Attribut im PUT- oder POST-Request vorhanden ist, das nicht in der Web-Entität als Attribut vermerkt ist, schlägt der Request mit Statuscode 400 fehl.

Bestehende Web-Entität bearbeiten

Vorgehensweise

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