Zum Inhalt springen

GitHub Update File-Aktivität

Einführung

Eine GitHub Update File-Aktivität, die über ihre GitHub-Verbindung erfolgt, aktualisiert eine Datei in GitHub und ist als Ziel gedacht, um Daten in einem Vorgang zu konsumieren.

Vorsicht

Die Update File-Aktivität ist veraltet. Wir empfehlen, stattdessen die Update-Aktivität zu verwenden.

Erstellen einer GitHub Update File-Aktivität

Eine Instanz einer GitHub Update File-Aktivität wird aus einer GitHub-Verbindung unter Verwendung des Aktivitätstyps Update File erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Entwurfsfläche oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsfläche ein. Für Details siehe Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Eine vorhandene GitHub Update File-Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer GitHub Update File-Aktivität

Befolgen Sie diese Schritte, um eine GitHub Update File-Aktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie die Einstellungen

In diesem Schritt geben Sie einen Namen für die Aktivität ein und spezifizieren die Datei. Jedes Benutzeroberflächenelement dieses Schrittes wird unten beschrieben.

Tipp

Felder mit einem Symbol für Variablen unterstützen die Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder, indem Sie eine öffnende eckige Klammer [ in das Feld eingeben oder indem Sie auf das Symbol für Variablen klicken, um ein Menü anzuzeigen, das vorhandene Variablen zur Auswahl auflistet.

  • Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede GitHub Update File-Aktivität eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • GitHub Repository Name: Geben Sie den Namen des Repositories ein, das die zu aktualisierende Datei enthält.

  • File Path of File to Be Updated: Geben Sie einen gültigen Dateipfad ein (zum Beispiel path/file.txt). Der Pfad sollte auf ein vorhandenes Verzeichnis in der GitHub-Instanz zeigen.

  • Commit Message: Geben Sie eine Commit-Nachricht ein, um dieses Commit zur Aktualisierung der Datei im Repository zu identifizieren. Die Commit-Nachricht sollte für jede Update File-Aktivität eindeutig sein.

  • SHA: Geben Sie die SHA für die Datei ein, die entweder von der Create file activity oder der Query file activity zurückgegeben wurde.

  • Save & Exit: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

  • Next: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie die Schaltfläche Fertig im letzten Schritt klicken.

  • Discard Changes: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen Sie die Datenschemata

Alle Anfrage- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

  • Data Schemas: Diese Datenschemata werden von benachbarten Transformationen geerbt und während der Transformation Mapping erneut angezeigt.

    Hinweis

    Die in einer Transformation bereitgestellten Daten haben Vorrang vor der Aktivitätskonfiguration.

    Der GitHub-Connector verwendet die GitHub REST API. Weitere Informationen zu den Schema-Knoten und -Feldern finden Sie in der API-Dokumentation.

    Die Daten-Schemas für Anfrage und Antwort bestehen aus diesen Knoten und Feldern:

    Anfrage-Schema Knoten/Feld Beschreibung
    updateFileRequest Knoten der Aktualisierungsanforderung für die Datei
    content Anfrageinhalt
    Antwort-Schema Knoten/Feld Beschreibung
    updateFileResponse Knoten der Antwort zur Aktualisierung der Datei
    repoName Name des Datei-Repositorys
    filePath Der Dateipfad
    fileSha Der Dateiprüfziffer-Hash
    commitMessage Zurückgegebene Commit-Nachricht
    errorMessage Zurückgegebene Fehlermeldung

  • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die Schemata vom GitHub-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie in einer angrenzenden Transformation.

  • Zurück: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • Fertig: Klicken Sie, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.

  • Änderungen verwerfen: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine GitHub Update File-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration des Vorgangs, indem Sie andere Aktivitäten oder Werkzeuge als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Betriebseinstellungen konfigurieren, die die Möglichkeit umfassen, Vorgänge zusammenzuführen, die sich in denselben oder unterschiedlichen Workflows befinden.

Menüaktionen für eine Aktivität sind im Projektbereich und auf der Entwurfsgrafik zugänglich. Für Details siehe Aktionsmenü der Aktivität in Connector-Grundlagen.

GitHub Update File-Aktivitäten können als Ziel mit diesen Betriebsmustern verwendet werden:

Ein typischer Anwendungsfall ist die Verwendung einer GitHub Update File-Aktivität im Zwei-Transformationsmuster. In diesem Beispiel erstellt die erste Transformation (Update File Request) eine Anforderungsstruktur, die an die GitHub Update File-Aktivität übergeben wird. Die zweite Transformation (Update File Response) empfängt die Antwortstruktur, die dann von einer Variablen Write-Aktivität (Write Update File Response) in eine Variable geschrieben wird, und eine Nachricht wird dann durch das Skript Write to Operation Log protokolliert.

Um die Aktivität mit Skriptfunktionen zu verwenden, schreibe die Daten an einen temporären Ort und verwende dann diesen temporären Ort in der Skriptfunktion.

Wenn du bereit bist, deploy and run die Operation und validiere das Verhalten, indem du die Betriebsprotokolle überprüfst.