Mandant-Plugins

Geändert am Mon, 22 Apr 2024 um 11:22 AM

Die Mandant-Plugin-Verwaltung ermöglicht es, im entsprechenden Mandanten eigene Logik einzubinden.

Ist im Manifest eines Plugins das Attribut Build-Time oder Build-Timestamp gesetzt, wird dessen Wert neben der Plugin-Version, sofern es sich um eine SNAPSHOT-Version handelt. Dies ist bei der Plugin-Entwicklung etwa sinnvoll, um zwischen verschiedenen SNAPSHOT-Versionen unterscheiden zu können.

Inhalt

Nutzeroberfläche zur Registrierung eines Mandant-Plugins.

Plugin hochladen

Mittels des Hochladen-Button lässt sich eine JAR-Datei auswählen, die dann automatisch hochgeladen wird. Im Feld Plugin-Name wird der Plugin-Name der hoch geladenen Datei angezeigt. Um Änderungen am Plugin zu übernehmen muss über den Speichern-Button die Plugin-Konfiguration gespeichert werden. Im Zuge des Speicherns erfolgt ein Prüfung, ob das Plugin verwendet werden kann.

Hinweis: Wenn die Datei keine Implementierung einer Schnittstelle von FORMCYCLE enthält, wird sie verworfen und nicht registriert.

Plugin aktualisieren

Plugins lassen sich auf zwei Arten aktualisieren: manuell über das Hochladen einer JAR-Datei für ein vorhandenes Plugin und automatisch durch den Klick auf den Update-Button, sobald ein Update für ein Plugin vorhanden ist.

Manuelle Aktualisierung

Über den Button für die manuelle Aktualisierung lässt sich das ausgewählte Plugin durch das Hochladen einer JAR-Datei aus dem eigenen Dateisystem aktualisieren . Um die manuelle Aktualisierung fertigzustellen muss das Plugin gespeichert werden, um die Änderungen zu übernehmen.

Benachrichtigungen für Plugin-Updates

Automatische Aktualisierung

Die automatische Aktualisierung des Plugins kann über einen der Update-Buttons erfolgen. Dabei wird automatisch die aktuelle Version des Plugins vom Update-Server heruntergeladen und das ausgewählte Plugin aktualisiert. Ob das Plugin aktuell ist oder ein Update benötigt, wird durch die Kennzeichnung in den Allgemeinen Informationen neben der Version angezeigt. Ist das Plugin als unbekannt gekennzeichnet, handelt es sich nicht um ein offizielles Plugin von formcycle.

Außerdem kann jederzeit geprüft werden, ob Updates für das Plugin verfügbar sind. Diese Prüfung erfolgt ebenfalls regelmäßig automatisch im Hintergrund. Sind Updates für Plugins verfügbar, wird dies im Benachrichtigungsbereich oben rechts angezeigt.

Hier werden alle möglichen Updates für Plugins angezeigt. Ein Klick auf den Link-Button führt direkt in die Plugin-Verwaltung des jeweiligen Mandanten. Außerdem können die Benachrichtigungen bei Bedarf wieder entfernt werden.

Plugin-Store

In der Plugin-Verwaltung kann über den Button unten links der Plugin-Store geöffnet werden. Dieser enthält alle frei verfügbaren Plugins.

Über den Button Installieren wird das Plugin automatisch im Hintergrund installiert. Um mehr Details über das Plugin zu erhalten, kann auf den Button Mehr lesen geklickt werden. Hier werden alle relevanten Informationen wie die Versionshistorie oder wichtige Metadaten des Plugins angezeigt.

Falls eines der Plugins bereits im Plugin-Store installiert ist und eine neue Version verfügbar ist, kann das Plugin auch über den Plugin-Store aktualisiert werden.

Plugin deaktivieren

Über die Schaltflächen kann das ausgewählte Plugin deaktiviert und über wieder aktiviert werden. Ein deaktiviertes Plugin verhält sich so, als ob es gelöscht worden wäre. Die konfigurierten Einstellungen des Plugins bleiben aber erhalten und das Plugin kann jederzeit wieder aktiviert werden.

Beschränkung auf Server

8.1.0+

Standardmäßig sind Plugins auf allen Server verfügbar (sofern das Plugin die Übertragung auf Frontend-Server unterstützt). Es ist optional möglich, ein Plugin nur auf Master- oder Frontend-Server einzuschränken. Dies ist eine fortgeschrittene Option und nur in einigen wenigen Fällen erforderlich, wie etwa bei Virenscanner-Plugins, die nur unter bestimmten Betriebssystem funktionieren können.

Versionshistorie

Die Versionshistorie beinhaltet eine Auflistung aller vorhandenen Versionen des installierten Plugins. Dabei werden Neuerungen, Änderungen und Korrekturen des Plugin genauer beschrieben. Gewisse Versionen eines Plugins können das Plugin für ältere formcycle-Versionen inkompatibel machen, wodurch das Plugin nur für höhere formcycle-Versionen kompatibel ist.

Enthaltene Plugins

Diese Tabelle listet alle gefundenen Plugins auf und ordnet sie dem jeweiligen Plugin-Typ zu.

Eigenschaften

Hier werden alle Properties definiert. Es können neue Werte hinzugefügt oder Bestehende bearbeitet bzw. gelöscht werden. Um zu erfahren, welche Eigenschaften und Werte hier erlaubt sind, sollte die Dokumentation zum Plugin zu Rate gezogen werden.