Jenkins Start Job-Aktivität
Einführung
Eine Jenkins Start Job-Aktivität, die ihre Jenkins-Verbindung verwendet, startet einen Job auf einem Jenkins-Automatisierungsserver und ist dazu gedacht, als Ziel zum Konsumieren von Daten in einem Vorgang verwendet zu werden.
Erstellen einer Jenkins Start Job-Aktivität
Eine Instanz einer Aktivität wird aus einer Verbindung unter Verwendung eines Aktivitätstyps 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 Aktivität kann von diesen Orten aus bearbeitet werden:
- Die Entwurfsfläche (siehe Komponentenaktionsmenü in Entwurfsfläche).
- Der Komponenten-Tab im Projektbereich (siehe Komponentenaktionsmenü in Projektbereich Komponenten-Tab).
Konfigurieren einer Jenkins Start Job-Aktivität
Befolgen Sie diese Schritte, um eine Jenkins Start Job-Aktivität zu konfigurieren:
-
Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie einen Job
Geben Sie einen Namen für die Aktivität ein und spezifizieren Sie einen Job. -
Schritt 2: Überprüfen Sie die Datenschemas
Alle Anfrage- oder Antwortschemas werden angezeigt.
Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie einen Job
In diesem Schritt geben Sie einen Namen für die Aktivität ein und spezifizieren Sie einen Job. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.
Die in diesem Schritt der Konfiguration einer Jenkins Start Job-Aktivität verwendete Schnittstelle hängt von der ausgewählten Option Jobnamen bereitstellen ab:
-
Jobnamen mit Objektliste bereitstellen: Diese Option füllt eine Liste von Jobs aus der Jenkins-Instanz aus.
-
Job-URL mit Textfeld bereitstellen: Bei dieser Option geben Sie manuell die URL des Jobs ein.
-
Parameter mit Anforderungsumwandlung bereitstellen: Bei dieser Option geben Sie die Daten für den Job in einer Anforderungsumwandlung an.
Jobnamen mit Objektliste bereitstellen
Wenn Jobnamen mit Objektliste bereitstellen für Jobnamen bereitstellen ausgewählt ist, wird diese Schnittstelle angezeigt:
Hinweis
Felder mit einem Variablen-Icon 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 Variablen-Icon klicken, um eine Liste der vorhandenen Variablen anzuzeigen.
-
Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede Jenkins Start Job-Aktivität eindeutig sein und darf keine Schrägstriche
/
oder Doppelpunkte:
enthalten. -
Jobnamen bereitstellen: Wählen Sie eine dieser Optionen zur Bereitstellung des Jobnamens:
-
Jobnamen mit Objektliste bereitstellen: Diese Option füllt eine Liste von Jobs aus der Jenkins-Instanz aus.
-
Job-URL mit Textfeld bereitstellen: Bei dieser Option geben Sie manuell die URL des Jobs ein.
-
Parameter mit Anforderungsumwandlung bereitstellen: Bei dieser Option geben Sie die Daten für den Job in einer Anforderungsumwandlung an.
-
-
Ein Objekt auswählen: Dieser Abschnitt zeigt eine Tabelle der in der Jenkins-Endpunkt verfügbaren Jobs an. Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer Zeile, um einen Job auszuwählen. Es kann nur ein Job ausgewählt werden.
- Ausgewähltes Objekt: Nachdem ein Job ausgewählt wurde, wird er hier aufgelistet.
-
Erweiterte HTTP-Eigenschaften: Klicken Sie auf das Hinzufügen-Symbol , um eine Zeile in der Tabelle unten hinzuzufügen und ein Schlüssel-Wert-Paar für jeden Anforderungsparameter einzugeben.
Um die Zeile zu speichern, klicken Sie auf das Senden-Symbol in der rechten Spalte.
Um eine einzelne Zeile zu bearbeiten oder zu löschen, fahren Sie mit der Maus über die rechte Spalte und verwenden Sie das Bearbeiten-Symbol oder das Löschen-Symbol .
Um alle Zeilen zu löschen, klicken Sie auf Alle löschen.
Wichtig
Felder in der Tabelle Erweiterte HTTP-Eigenschaften zeigen das Variablen-Symbol nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit befüllt werden, muss die Agenten-Version mindestens 10.75 / 11.13 sein.
Felder in der Tabelle Erweiterte HTTP-Eigenschaften unterstützen nicht die Verwendung von Variablen, um rohes JSON zu übergeben. Wenn Ihr Anwendungsfall nicht unterstützt, rohes JSON direkt in den Feldern zu definieren, entkommen Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Zum Beispiel wird
{"success": "true"};
zu{\"success\": \"true\"};
. -
Fortfahren bei Fehler: Diese Einstellung ist nur funktionsfähig, wenn die Option Parameter mit Anforderungsumwandlung bereitstellen verwendet wird.
-
Speichern & Beenden: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.
-
Weiter: 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 auf die Schaltfläche Fertig im letzten Schritt klicken.
-
Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.
Job-URL über Textfeld bereitstellen
Wenn Job-URL über Textfeld bereitstellen für Jobnamen bereitstellen ausgewählt ist, wird diese Schnittstelle angezeigt:
Tipp
Felder mit einem Variablen-Icon 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 Variablen-Icon klicken, um eine Liste der vorhandenen Variablen anzuzeigen.
-
Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede Jenkins Start Job-Aktivität eindeutig sein und darf keine Schrägstriche
/
oder Doppelpunkte:
enthalten. -
Jobnamen bereitstellen: Wählen Sie eine dieser Optionen zur Bereitstellung des Namens des Jobs:
-
Jobnamen mit Objektliste bereitstellen: Diese Option füllt eine Liste von Jobs aus der Jenkins-Instanz aus.
-
Job-URL über Textfeld bereitstellen: Bei dieser Option geben Sie manuell die URL des Jobs ein.
-
Parameter über Anforderungsumwandlung bereitstellen: Bei dieser Option geben Sie die Daten für den Job in einer Anforderungsumwandlung an.
-
-
Job-URL: Geben Sie die Job-URL ein.
-
Bei Fehler fortfahren: Diese Einstellung ist nur funktionsfähig, wenn die Option Parameter über Anforderungsumwandlung bereitstellen verwendet wird.
-
Speichern & Beenden: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.
-
Weiter: 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.
-
Änderungen verwerfen: Nach Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die vorgenommenen Änderungen zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen wirklich verwerfen möchten.
Parameter über Anforderungsumwandlung bereitstellen
Wenn Parameter über Anforderungsumwandlung bereitstellen für Jobnamen bereitstellen ausgewählt ist, wird diese Schnittstelle angezeigt:
-
Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede Jenkins Start Job-Aktivität eindeutig sein und darf keine Schrägstriche
/
oder Doppelpunkte:
enthalten. -
Provide Job Name: Wählen Sie eine dieser Optionen zur Angabe des Namens des Jobs:
-
Provide Job Name Using Object List: Diese Option füllt eine Liste von Jobs aus der Jenkins-Instanz aus.
-
Provide Job URL Using Text Field: Bei dieser Option geben Sie manuell die URL des Jobs ein.
-
Provide Parameters Using Request Transformation: Bei dieser Option geben Sie die Daten für den Job in einer Anforderungsumwandlung an.
-
-
Continue on Error: Wählen Sie diese Option, um die Ausführung der Aktivität fortzusetzen, wenn ein Fehler für einen Datensatz in einer Batch-Anforderung auftritt. Wenn Fehler auftreten, werden diese im Betriebsprotokoll aufgezeichnet.
-
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 fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.
Step 2: Überprüfen der Datenschemata
Alle Anforderungs- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.
-
Data Schemas: Diese Datenschemata werden von angrenzenden Transformationen geerbt und während der Transformation Mapping erneut angezeigt.
Hinweis
Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.
Der Jenkins-Connector verwendet die Jenkins Remote Access API. Die Anforderungs- und Antwortschemata sind statisch und werden intern vom Connector selbst bereitgestellt.
Die Start Job-Aktivität verwendet XML sowohl in ihren Anfrage- als auch in ihren Antwortschemata.
Die Anfrage- und Antwortdatenschemata bestehen aus diesen Knoten und Feldern:
Anfrage-Schema Knoten/Feld Beschreibung jobProperties
Knoten, der den Job darstellt jobUrl
Die Job-URL jobParameters
Knoten, der die Schlüssel-Wert-Paare darstellt parameterKey
Der Schlüssel in einem Schlüssel-Wert-Paar parameterValue
Der Wert in einem Schlüssel-Wert-Paar Antwort-Schema Knoten/Feld Beschreibung response
Knoten, der die Antwort darstellt job
Knoten, der den Jobstatus darstellt message
Zeichenfolge, die die Antwortnachricht für den Job enthält status
HTTP-Antwortstatuscode, der zurückgegeben wird url
Zeichenfolge, die die Job-URL enthält -
Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die Schemata vom Jenkins-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie in einer benachbarten 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 Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen verwerfen möchten.
Nächste Schritte
Nachdem Sie eine Jenkins Start Job-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.
Jenkins Job starten-Aktivitäten können als Ziel mit diesen Betriebsmustern verwendet werden:
- Transformationsmuster
- Zwei-Transformationsmuster (als erstes oder zweites Ziel)
Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Ort und verwenden Sie dann diesen temporären Ort in der Skriptfunktion.
Wenn Sie bereit sind, bereitstellen und ausführen Sie den Vorgang und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.