Plugins

Plugins bieten die Möglichkeit Funktionen und/oder Benutzeroberflächen dynamisch in die Anwendung IDA (siehe IDA) zu integrieren. Ein Plugin bezieht sich dabei immer auf genau ein Geschäftsobjekt, es können jedoch mehrere Plugins für jeweils unterschiedliche Geschäftsobjekte definiert werden. Plugins sind zunächst unabhängig von Iterationen, in der Entwicklung der Plugins können aber Iterations-spezifische Abläufe implementiert werden.

Um eine möglichst hohe Flexibilität und Unabhängigkeit zu ermöglichen, können Plugins durch Sie selbst entwickelt und eingebunden werden (es ist keinerlei Verarbeitung / Eingriff durch uns notwendig, daher entstehen für Sie auch keine zusätzlichen Kosten). Auf Ihren Wunsch hin können Sie die Entwicklung von Plugins aber natürlich auch (kostenpflichtig) beauftragen.

Plugin-Entwicklung

Die Plugins werden in Java entwickelt, die verwendete Java-Version können Sie in Ihrer Instanz der Anwendung in den Administrations-Einstellungen einsehen. Wir empfehlen die Entwicklung basierend auf dem Referenz-Plugin. Außerdem empfehlen wir die Entwicklung eines eigenen Plugins in einer entsprechende Entwicklungsumgebung vorzunehmen (das Referenz-Plugin wurde mit Eclipse 2018-12 erstellt).

Ein Plugin muss zwingend notwendige Schnittstellen (Interfaces) implementieren um in die Applikation integriert werden zu können. Folgende Klassen bilden das Grundgerüst für die Entwicklung:

  • CustomBusinessObjectSettings: Dieses Interface muss immer implementiert werden (je Plugin genau einmal), es bündelt alle Funktionen und Benutzeroberflächen des Plugins
  • PluginFunction: Definiert eine Funktion / Hintergrundprozess und wird über CustomBusinessObjectSettings dem Plugin zugeordnet
  • UIPlugin: Definiert eine Benutzeroberfläche und wird über CustomBusinessObjectSettings dem Plugin zugeordnet
  • PluginExport: Definiert einen Export und wird über CustomBusinessObjectSettings dem Plugin zugeordnet
  • PluginImprt: Definiert einen Import und wird über CustomBusinessObjectSettings dem Plugin zugeordnet
  • PluginAPIService: Definiert eine API-Funktion/Aufruf/Service und wird über CustomBusinessObjectSettings dem Plugin zugeordnet

Die Dokumentation (Javadoc) der Interfaces finden Sie in Abschnitt Dokumentation. Die Interfaces selbst sind im folgendem Paket definiert:

Version 1.8:

ida-utils.jar

Version 1.7:

ida-utils.jar

Version 1.6:

ida-utils.jar

Version 1.5

ida-utils.jar

Version 1.4:

ida-utils.jar

Dokumentation

Folgende Datei enthält die Dokumenation der relevanten Schnittstellen.

Version 1.8:

Javadoc.zip oder javadoc.jar

Version 1.7:

Javadoc.zip oder javadoc.jar

Version 1.6:

Javadoc.zip

Version 1.5:

Javadoc.zip

Version 1.4:

Javadoc.zip

Referenz-Plugin

In diesem Abschnitt wird beschrieben, wie Sie Ihr eigenes Plugin (basierend auf dem Referenz-Plugin) entwickeln können.

  1. Laden Sie zunächst das Referenzprojekt herunter und entpacken Sie das Archiv lokal (am besten in Ihrem Workspace):
  2. Importieren Sie das entpackte Projekt in Ihre Entwicklungsumgebung (die Projekte wurden mit Eclipse 2018-12 erstellt)
  3. Durchlaufen Sie die TODOs in den definierten Klassen, insbesondere MyCustomBusinessObjectSettings.java,
    da diese Klasse Ausgangspunkt des Plugins ist und definiert für welches Geschäftsobjekt das Plugin gilt.
    Passen Sie die Funktion / Benutzeroberflächen nach Ihren Bedürfnissen an.
  4. Erstellen Sie eine .jar-Datei aus Ihrem Projekt
  5. Laden Sie die .jar-Datei in den Administrations-Einstellungen wie folgt hoch:
    • Im Feld „Class“ tragen Sie den Namen der Klasse (WICHTIG: inklusive dem Namen des Packages) ein, welche das CustomBusinessObjectSettings-Interface implementiert
    • Im Feld „Plugin“ wählen Sie die .jar-Datei aus Schritt 4 aus
  6. Falls das Plugin Benutzeroberflächen definiert, müssen Sie die Anwendung neu starten damit die Oberflächen eingebunden werden
  7. Nun können die Plugin-Funktionen und –Benutzeroberflächen aufgerufen werden