Plugin konfigurieren

Auf der Registerkarte „Kommunikation“ können Sie eine Instanz des REST-Plugins hinzufügen, die Parameter konfigurieren sowie das Plugin direkt in der Benutzeroberfläche starten und beenden.

Die RESTful-API und die integrierte Webanwendung (sofern aktiviert) sind nur verfügbar, wenn das Plugin aktiv ist.

Konfiguration im MERLIC RTE Setup aktivieren

Um die Konfiguration des Plugins auf der MERLIC RTE Setup-Registerkarte „Kommunikation“ zu ermöglichen, müssen Sie zuerst MERLIC RTE starten und die folgenden Schritte ausführen:

  1. Öffnen Sie das MERLIC RTE Setup und wählen Sie die Registerkarte „Kommunikation“ aus. Falls MERLIC RTE nicht ausgeführt wird, können Sie es direkt auf der Registerkarte „Kommunikation“ starten.
  2. Fügen Sie das REST-Plugin zur Liste der Plugin-Instanzen auf der linken Seite hinzu.

  3. Vergewissern Sie sich, dass das Plugin noch nicht ausgeführt wird. Andernfalls sind die Parameter nicht für die Konfiguration verfügbar. Der aktuelle Zustand des Plugins ist am jeweiligen Statussymbol in der Liste der Plugin-Instanzen erkennbar. Wird das Symbol als Status angezeigt, ist das Plugin aktiv. In diesem Fall müssen Sie es durch Klicken auf die Schaltfläche „ Plugin stoppen“ unten im MERLIC RTE Setup stoppen. Wird stattdessen das Symbol als Status angezeigt, ist das Plugin derzeit nicht aktiv. In der folgenden Beispielabbildung ist die ausgewählte Instanz des REST-Plugins derzeit nicht aktiv, sodass die Konfiguration möglich ist.

  4. Wählen Sie das REST-Plugin auf der linken Seite aus, um die zugehörigen Parameter anzuzeigen und die Konfiguration zu beginnen.

Die Parameter des ausgewählten REST-Plugins werden auf der rechten Seite der Registerkarte „Kommunikation“ angezeigt.

Plug-in Parameters

Parameter dieses Typs stellen allgemeine Parameter für das Kommunikations-Plugin dar, die nicht im Konfigurationsbereich der Registerkarte „Kommunikation“ angepasst werden können. Sie können die Versionsnummer des Plugins, den aktuellen Parameterwert für die Log-Ebene, die Zugriffsebene des Plugins und die Einstellung für die Überprüfung der Plugin-Konfiguration anzeigen. Diese Werte müssen an anderen Stellen bzw. mit anderen Methoden festgelegt werden.

Version

Dieser Parameter zeigt die Versionsnummer an, die bei der Plugin-Implementierung definiert wurde. Er besteht aus einer Haupt-, Neben- und Wartungsversion. Sie wird auch beim Hinzufügen einer neuen Plugin-Instanz angezeigt. Die Version ist optional. Daher ist es möglich, dass bei der Implementierung keine Versionsnummer definiert wurde.

Log level

Dieser Parameter zeigt die Log-Ebene für die Plugin-Instanz an. Als Log-Ebene wird standardmäßig die Log-Ebene des jeweiligen MERLIC RTE-Prozesses festgelegt, wenn die Plugin-Instanz im MERLIC RTE Setup hinzugefügt wird.

Access level

Dieser Parameter zeigt die für das Plugin festgelegte Zugriffsebene an. Für das REST-Plugin ist die Zugriffsebene standardmäßig auf „monitor and control“ festgelegt, d. h., das Plugin kann „Ereignisse“ empfangen und „Aktionen“ senden. Die Zugriffsebene bestimmt die Berechtigung, die in der Implementierung des Plugins definiert wird. Die Zugriffsebene kann im MERLIC RTE Setup nicht angepasst werden.

Supports rapid validation

Dieser Parameter zeigt an, ob das Plugin die umgehende Validierung der aktuellen Plugin-Konfiguration unterstützt. Für dieses Plugin ist das Kontrollkästchen aktiviert, d. h., dass eine „schnelle Validierung“ unterstützt wird. Das bedeutet, dass die Konfiguration des Plugins bei jeder Änderung eines bearbeitbaren Parameter auf der Registerkarte „Kommunikation“ des MERLIC RTE Setups überprüft wird. Wenn das Plugin keine „schnelle Validierung“ unterstützt, wird die Konfiguration des Plugins nur beim Speichern der Konfiguration überprüft.

User Parameters

Die „User parameters“ stellen die Parameter dar, die für das Plugin konfiguriert werden können. Sie werden in verschiedenen Kategorien angezeigt, die erweitert oder geschlossen werden können.

Die Parameter der einzelnen Kategorien werden in den folgenden Abschnitten beschrieben.

HTTP Server

Die Parameter in dieser Kategorie definieren die Einstellungen für den HTTP-Server.

Die folgende Abbildung enthält eine Übersicht über die Parameter mit der jeweiligen Standardeinstellung. Unter der Abbildung finden Sie eine ausführliche Beschreibung der Parameter.

IP address

Dieser Parameter definiert die Internet Protocol-Adresse (IP‑Adresse) der Netzwerkschnittstelle, die der Server auf Verbindungen überwachen soll. Der Parameter unterstützt IPv4-Adressen (Internet Protocol-Version 4) und IPv6‑Adressen.

Die Standardeinstellung ist „127.0.0.1“, sodass die RESTful-API und die integrierte Webanwendung nur auf dem lokalen Computer erreichbar sind. Wenn sie von einem anderen Gerät im selben Netzwerk aus erreichbar sein sollen, muss die entsprechende IP-Adresse des jeweiligen Computers in diesem Netzwerk angegeben werden.

Port

Dieser Parameter definiert den Port, den der Server auf neue Verbindungen überwachen soll. Die Standardeinstellung ist „8040“.

Serve built-in web app

Dieser Parameter gibt an, ob die integrierte Webanwendung das oben angegebene System als Server verwendet. Diese Option ist standardmäßig aktiviert, sodass die Webanwendung im Webbrowser unter http://127.0.0.1:8040 erreichbar ist, sofern das Plugin mit den Standardeinstellungen ausgeführt wird.

In-Memory Database

Die Parameter in dieser Kategorie definieren die Einstellungen für die Pufferkapazität von Ereignissen, Ergebnissen und Fehlern. Die Kapazität von Aktionen und Jobs ist auf 1 MB festgelegt und kann nicht geändert werden.

Die folgende Abbildung enthält eine Übersicht über die Parameter mit der jeweiligen Standardeinstellung. Unter der Abbildung finden Sie eine ausführliche Beschreibung der Parameter.

Event store capacity

Dieser Parameter definiert die Größe des Puffers, in dem Ereignisse gespeichert werden. Die Standardeinstellung ist 64 MB.

Result store capacity

Dieser Parameter definiert die Größe des Puffers, in dem Ergebnisse gespeichert werden. Die Standardeinstellung ist 128 MB.

Error store capacity

Dieser Parameter definiert die Größe des Puffers, in dem Fehlerinformationen gespeichert werden. Die Standardeinstellung ist 16 MB.

Data retention rate

Dieser Parameter definiert den prozentualen Anteil des im Puffer beibehaltenen Speichers, wenn Speicher zurückgefordert wird, weil die Kapazität des jeweiligen Puffers erreicht ist. Die Standardeinstellung ist 70 %. Das heißt, dass 30 % des Speichers zurückgefordert und 70 % beibehalten werden.

Die angegebene Beibehaltungsquote gilt für den Puffer aller Datentypen in der Datenbank einschließlich Aktionen und Jobs, deren Kapazität exakt 1 MB beträgt.