Zum Inhalt springen
Znuny Community Docs

Plugin-Entwicklung mit OPM-Paketen

Plugin-Entwicklung mit OPM-Paketen

Abschnitt betitelt „Plugin-Entwicklung mit OPM-Paketen“

In diesem Abschnitt lernst du, wie du eigene Plugins als OPM-Pakete für Znuny erstellst, installierst und verteilst.

Abschnitt betitelt „In diesem Abschnitt lernst du, wie du eigene Plugins als OPM-Pakete für Znuny erstellst, installierst und verteilst.“

1. Aufbau einer .sopm

Abschnitt betitelt „1. Aufbau einer .sopm“

Die SOPM-Datei (*.sopm) enthält alle Metadaten deines Pakets: `.sopm“

  • Name/Version/Framework: Eindeutige Paketkennung und kompatible Znuny-Version.
  • Filelist: Alle Dateien, die beim Installieren kopiert werden.

2. Dateien & Verzeichnisstruktur

Abschnitt betitelt „2. Dateien & Verzeichnisstruktur“

Lege dein Paket in einem eigenen Verzeichnis an, z.B. MyExtension/: *.sopm

  • Kernel/Config/Files/XML/: Registriert Module, Menüs oder Dynamic Fields.
  • Kernel/System/: Geschäftslogik-Klasse.
  • Kernel/Modules/: Frontend-Controller.
  • Templates & Sprache: TT-Dateien + Übersetzungs-.pm.

3. Paket bauen & installieren

Abschnitt betitelt „3. Paket bauen & installieren“

3.1 OPM erzeugen

Abschnitt betitelt „3.1 OPM erzeugen“

Nutze das CLI-Tool, um aus deiner SOPM ein OPM zu bauen: MyExtension/

3.2 Installation

Abschnitt betitelt „3.2 Installation“

Admin-UI: Paket hochladen unter Admin → Einstellungen → Paketverwaltung. Konsole: Kernel/Config/Files/XML/MyExtension.xml Zum Deinstallieren bzw. Aktualisieren: Kernel/System/DynamicField/Driver/MyCustomField.pm

Abschnitt betitelt „Admin-UI: Paket hochladen unter Admin → Einstellungen → Paketverwaltung. Konsole: Kernel/Config/Files/XML/MyExtension.xml Zum Deinstallieren bzw. Aktualisieren: Kernel/System/DynamicField/Driver/MyCustomField.pm“

4. Erweiterungspunkte

Abschnitt betitelt „4. Erweiterungspunkte“

4.1 Dynamic Fields

Abschnitt betitelt „4.1 Dynamic Fields“

In Kernel/Config/Files/XML/MyExtension.xml registrierst du einen neuen Dynamic Field Driver: Kernel/System/Event/Handler/MyHandler.pm Implementiere den Driver in Kernel/System/DynamicField/Driver/MyCustomField.pm.

4.2 Event-Handler

Abschnitt betitelt „4.2 Event-Handler“

Melde deinen Event-Handler an: Run() Handler in Kernel/System/Event/Handler/MyHandler.pm implementieren (Run()-Methode).

4.3 Output-Filter

Abschnitt betitelt „4.3 Output-Filter“

Kernel/System/Output/Filter/MyFilter.pm Filter in Kernel/System/Output/Filter/MyFilter.pm.

Abschnitt betitelt „Kernel/System/Output/Filter/MyFilter.pm Filter in Kernel/System/Output/Filter/MyFilter.pm.“

5. Deployment & OTOpar

Abschnitt betitelt „5. Deployment & OTOpar“
  • Repository-Index: Erzeuge Packages.xml für eigenes Repo: Packages.xml
  • Füge unter SysConfig Package::RepositoryList deine Repo-URL ein.
  • OTOpar: Lade dein OPM bei https://otopar.perl-services.de hoch, damit andere es direkt installieren können.

6. Beispiel: MyCalendar-Paket

Abschnitt betitelt „6. Beispiel: MyCalendar-Paket“
  1. SOPM anlegen mit Name MyCalendar.
  2. DB-Skript sql/create_calendar.sql für Tabelle calendar_events.
  3. Konfig-XML definiert neues Ticket-Feld „Termin“.
  4. Core-Modul Kernel/System/CalendarEvent.pm mit CRUD-Methoden.
  5. Frontend-Module Kernel/Modules/AgentCalendar.pm, Template AgentCalendar.tt.
  6. Paket bauen und in OTOpar upladen.

7. Tipps & Best Practices

Abschnitt betitelt „7. Tipps & Best Practices“
  • Versionsnummer im sopm anpassen (SemVer).
  • DB-Migrationen in sql/ sauber versionieren.
  • Unit-Tests für System- und Module-Klassen anlegen.
  • Dokumentation im README plus POD in Perl-Modulen.
  • Translations in Language/de_*.pm und en_*.pm. Damit hast du eine solide Basis, um eigene Znuny-Plugins zu entwickeln, zu verteilen und in Kundenprojekten wartbar einzusetzen. Viel Spaß!