Zum Inhalt springen

Erstellen von App Builder-Plugins mit C# im Jitterbit App Builder

Plugins sind Erweiterungen, die die Funktionalität des App Builders erweitern. Eine Reihe von Plugins wird mit dem App Builder ausgeliefert und steht sofort zur Nutzung zur Verfügung. Entwickler können jedoch auch eigene Skripte erstellen, um die Bandbreite möglicher Anwendungen zu erhöhen. Diese Seite beschreibt, wie das geht.

Einzelheiten zu benutzerdefinierten Skripten

Benutzerdefinierte C#-Skripte werden mit dem Roslyn .NET-Compiler kompiliert. Jeder Skripttyp definiert eine Reihe von globalen Mitgliedern, die Zugriff auf Objekte und Dienste bieten.

Jedes C#-Skript hat einen Zweck, der bestimmt, wie und wo das Plugin verwendet werden kann. Ein Plugin kann auch eine Berichtdatei generieren. Sie wählen einen Zweck für Ihr benutzerdefiniertes Plugin aus, während Sie es erstellen. Die Zwecke, die ein C#-Skript erfüllen kann, sind im Abschnitt So erstellen Sie ein C#-Plugin aufgeführt.

Assemblies

App Builder-Plugins können über die Verwendung von Assemblies auf externen Code verweisen. Eine Assembly ist eine Datei (normalerweise mit der Endung .dll), die eine Bibliothek von vorgefertigtem Code enthält, den Ihr Skript ausleihen kann, um spezifische Aufgaben auszuführen, zum Beispiel komplexe Mathematik oder das Nachschlagen der IP-Adresse einer Website.

Seit App Builder 4.57 ist es möglich, ein Bibliotheksarchiv (ZIP-Datei) hochzuladen, das die spezifischen Versionen der Assemblies enthält, die Ihr Skript benötigt. Dies stellt sicher, dass Ihr Skript isoliert und stabil bleibt, selbst wenn der Rest des Systems aktualisiert wird.

Nachdem Sie Ihre Assembly in den App Builder hochgeladen haben, weisen Sie Ihre Skripte an, sie zu verwenden, indem Sie eine Referenzdirektive ganz oben in Ihrem Code hinzufügen (siehe den Abschnitt So erstellen Sie ein C#-Plugin).

So erstellen Sie ein C#-Plugin im App Builder

Um ein C#-Plugin im App Builder zu erstellen, befolgen Sie diese Schritte:

  1. Auf dem Server, auf dem Sie Ihr Skript verwenden möchten, navigieren Sie zu IDE > Zusätzliche Einstellungen.

  2. Klicken Sie auf Plugins.

  3. Das Panel Assemblies listet die vorhandenen Assemblies auf. Wenn die benötigte Assembly bereits vorhanden ist, wählen Sie sie aus und fahren Sie mit Schritt 4 fort. Wenn nicht, befolgen Sie diese Schritte, um sie zu erstellen:

    1. Klicken Sie auf + Assembly. Ein Dialog öffnet sich:

      Dialog zur Erstellung einer Assembly

    2. Füllen Sie die folgenden Felder aus:

      • Name: Geben Sie einen Namen für die neue Assembly ein.

      • Beschreibung: (Optional) Geben Sie eine kurze Beschreibung der Assembly ein, um anderen Entwicklern zu helfen.

      • Typ: Wählen Sie eine der Optionen aus:

        • Kompiliert: Plugins werden als Teil einer .NET-Assembly kompiliert.

        • Skripte: Plugins sind skriptbasiert.

      • Assembly-ID: Eindeutige Identifikationsnummer der Assembly. Dieses Feld wird automatisch vom App Builder generiert.

      • Bibliotheken: Suchen Sie die ZIP-Datei, die alle für die Skripte in dieser Assembly erforderlichen Assemblies oder Ressourcen enthält, und laden Sie sie hoch. Das Archiv wird vor der Ausführung von Plugins auf die Festplatte extrahiert. Alle Assemblies werden automatisch registriert und stehen den Skripten zur Verfügung.

  4. Das Plugins-Panel listet die vorhandenen Plugins auf. Klicken Sie auf + Plugin, um ein neues hinzuzufügen. Ein Dialog öffnet sich:

    Dialog zur Erstellung eines Plugins

  5. Füllen Sie die folgenden Felder aus:

  6. Klicken Sie auf Speichern. Der App Builder erstellt das Plugin und das Skript-Panel wird zu einem bearbeitbaren Feld, in das Sie Ihren C#-Code eingeben können.

    Wenn Sie eine externe Bibliothek in Ihrem Skript verwenden möchten, würden Sie diese hier mit der #r-Direktive (die für "Referenz" steht) am Anfang Ihres Codes referenzieren. Zum Beispiel:

    #r "AssemblyName"

Hinweis

Siehe auch Vinyl.SDK-Skripting-Klassen und Plugin-Beispielbibliothek.