Dokumentation

Plugins

Erweiterungen installieren, konfigurieren und pro Environment oder Website aktivieren.

Allgemein

Plugins erweitern simplebis innerhalb einer Umgebung. Ein Plugin kann eigene Manager-Funktionen, Datentypen, Formulare, Automatisierungen, Konfigurationsschemas und Website-Bausteine bereitstellen. Die Installation erfolgt immer für ein konkretes Environment; erst danach stehen die Plugin-Funktionen in dieser Umgebung zur Verfügung.

Wichtig ist die Trennung zwischen installiert und aktiv genutzt: Ein Plugin kann in einem Environment installiert sein, ohne automatisch auf einer Website aktiv zu sein. Für Webseiten wird ein installiertes Plugin zusätzlich in der jeweiligen Website unter Plugins aktiviert. Dadurch kann dieselbe Umgebung mehrere Websites betreiben, die unterschiedliche Plugin-Funktionen verwenden.

Im Manager

Plugins werden im Manager unter Einstellungen > Plugins verwaltet. Die Seite unterscheidet zwischen eigenen Plugins der Umgebung und installierten Plugins.

  • Eigene Plugins der Umgebung: Plugins, die in der aktuellen Umgebung erstellt wurden. Diese können bearbeitet werden und enthalten die eigentlichen Definitionen für Scopes, Datentypen, Formulare, Konfigurationen, Automatisierungen und Website-Bausteine.
  • Installierte Plugins: Plugins, die in der Umgebung verfügbar sind. Dazu gehören eigene Plugins, installierbare Plugins aus anderen Umgebungen und Website-Preset-Module.
  • Plugins installieren: öffnet den Installer. Dort können installierbare Plugins nach Kategorie und Suche ausgewählt werden.
  • Plugin erstellen: legt ein neues eigenes Plugin an und installiert es automatisch in der aktuellen Umgebung als Creator-Plugin.

Beim Bearbeiten eines eigenen Plugins zeigt der Editor die Bereiche Allgemeines, Automatisierungen, Datentypen, Formulare, Konfigurationen und, sofern Website-Zugriff vorhanden ist, Websites.

Scopes und Zugriff

Scopes bestimmen, auf welche Systembereiche ein Plugin zur Laufzeit zugreifen darf. Im Plugin werden diese Zugriffe im Bereich Allgemeines aktiviert. Ältere Plugin-Schnittstellen zeigen dafür einzelne Boolean-Felder wie Shops API Zugriff, Events API Zugriff, Websites API Zugriff, WebEmbeds API Zugriff oder Accounting-Documents API Zugriff. Neuere Plugins verwenden MCP/API Zugriff, bei dem einzelne Server und Tools gezielter freigeschaltet werden.

Diese Scopes wirken sich direkt auf die späteren Plugin-Funktionen aus. Website-Seiten, Website-Komponenten und Plugin-Kontexte können nur die freigegebenen MCP/API-Funktionen verwenden. Dadurch wird verhindert, dass ein Website-Baustein versehentlich auf nicht vorgesehene Datenbereiche zugreift.

Der Website-Bereich im Plugin-Editor erscheint nur, wenn das Plugin Website-Funktionen bereitstellen darf: über Website-/WebEmbed-Scopes oder über aktivierte websitefähige MCP/API-Scopes. Für Website-Konfigurationen gilt zusätzlich: Das Schema Websites wird nur angeboten, wenn das Plugin Website-Zugriff besitzt.

Installation im Environment

Die Installation verbindet ein Plugin mit der aktuellen Umgebung. Technisch entsteht ein Environment-Plugin-Eintrag. Erst dieser Eintrag macht das Plugin in der Umgebung sichtbar, zum Beispiel im Plugin-Editor, bei Plugin-Datentypen oder in der Website-Plugin-Auswahl.

Installierbar sind Plugins, bei denen Im Plugin-Installer sichtbar aktiv ist, sowie die eingebauten Website-Preset-Module. Bereits installierte Plugins werden im Installer nicht erneut angeboten. Bei Presets wird kein normaler Plugin-Datensatz kopiert; stattdessen wird das Preset als installierbares Website-Preset-Modul in der Umgebung registriert.

Die Installation allein verändert noch keine Website-Seiten, Datensätze oder Automationen. Solche Auswirkungen entstehen erst, wenn die jeweilige Plugin-Funktion genutzt wird: ein Datentyp wird bearbeitet, eine Automation ausgeführt, eine Website-Konfiguration gespeichert oder ein Website-Plugin auf einer Website aktiviert.

Aktivieren in Webseiten

Website-Plugins werden pro Website unter Webseiten > Website öffnen > Plugins aktiviert. Dort erscheinen installierte Plugins, die für Websites relevant sind. Ein normales Plugin wird über Aktivieren in die aktiven Plugins der Website aufgenommen und kann danach Komponenten, Kontexte und Website-Konfigurationen bereitstellen.

Website-Preset-Module verhalten sich umfangreicher: Beim Aktivieren öffnet der Manager ein Modal mit den enthaltenen Seiten, Komponenten, Styling-Dateien und Kontexten. Seiten können bei der Aktivierung kopiert werden. Bei URL-Konflikten kann gewählt werden, ob die vorhandene Seite verschoben, überschrieben oder die Plugin-Seite übersprungen wird. Bereits installierte Preset-Seiten können später zurückgesetzt, entfernt oder einzeln installiert werden.

Wenn ein Preset Design-Komponenten enthält, kann beim Aktivieren ein Basis-Design ausgewählt und auf Plugin-Seiten oder bestehende Website-Seiten angewendet werden. Beim Deaktivieren eines Preset-Moduls entfernt simplebis die kopierten Plugin-Seiten wieder und nimmt das Preset aus der aktiven Plugin-Liste der Website.

Unterseiten

Die folgenden Unterseiten beschreiben die einzelnen Plugin-Bereiche im Detail:

  • Automatisierungen: manuell ausführbare Plugin-Aktionen mit Parametern, Queue oder Sofortausführung.
  • Datentypen: eigene Datenmodelle mit Tabellen, Import, Aktionen und Backend-Code.
  • Formulare: Plugin-Formulare, die im Manager oder in Plugin-Abläufen verwendet werden können.
  • Konfigurationen: Standard- und Website-Konfigurationsschemas und deren Wirkung zur Laufzeit.
  • Websites: Plugin-Seiten, Komponenten, Kontexte, Website-Aktivierung und Standard-Presets.