Zum Inhalt springen

Jira-Suchaktivität

Einführung

Eine Jira -Suchaktivität, die ihre Jira-Verbindung verwendet, ruft Objektdaten aus einem Jira-Projekt ab und soll als Quelle zum Bereitstellen von Daten in einer Operation verwendet werden.

Erstellen einer Jira-Suchaktivität

Eine Instanz einer Jira Suche-Aktivität wird aus einer Jira-Verbindung erstellt mithilfe des Aktivitätstyps Suchen.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Design-Canvas oder kopieren Sie ihn und fügen Sie ihn dort ein. Weitere Informationen finden Sie unter Erstellen einer Aktivitäts- oder Tool-Instanz in Komponentenwiederverwendung.

Eine vorhandene Jira -Such-Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer Jira-Suchaktivität

Führen Sie die folgenden Schritte aus, um eine Jira -Suchaktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und wählen Sie ein Projekt aus

Geben Sie in diesem Schritt einen Namen für die Aktivität ein und wählen Sie ein Projekt aus. Die einzelnen Benutzeroberflächenelemente dieses Schritts werden unten beschrieben.

Jira-Suchaktivitätskonfiguration Schritt 1

  • Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede Jira Suchaktivität eindeutig sein und darf keine Schrägstriche enthalten. /oder Doppelpunkte :.

  • Projekt auswählen: In diesem Abschnitt werden die im Jira Endpoint verfügbaren Projekte angezeigt.

    • Ausgewähltes Jira-Projekt: Nachdem ein Projekt ausgewählt wurde, wird es hier aufgelistet.

    • Suchen: Geben Sie den Wert einer beliebigen Spalte in das Suchfeld ein, um die Projektliste zu filtern. Die Suche berücksichtigt keine Groß- und Kleinschreibung. Wenn bereits Projekte in der Tabelle angezeigt werden, werden die Tabellenergebnisse mit jedem Tastendruck in Echtzeit gefiltert. Um Projekte während der Suche vom Endpoint neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie anschließend die Seite, wie unten beschrieben.

    • Aktualisieren: Lädt Projekte vom Jira Endpoint neu. Dies kann nützlich sein, wenn Projekte zu Jira hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der in der Konfiguration angezeigten Projekttabelle verwendet wurden.

    • Projekt auswählen: Klicken Sie in der Tabelle auf eine beliebige Zeile, um ein Projekt auszuwählen. Es kann nur ein Projekt ausgewählt werden. Die für jedes Projekt verfügbaren Informationen werden vom Jira Endpoint abgerufen:

      • Name: Der Name des Projekts.

      • Beschreibung: Die Beschreibung des Projekts.

    Tipp

    Wenn die Tabelle nicht mit verfügbaren Projekten gefüllt ist, wird die Jira Verbindung ist möglicherweise nicht erfolgreich. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.

  • Optionale Einstellungen: Klicken Sie, um diese optionale Einstellung zu erweitern:

    • Bei Fehler den Operation abbrechen: Wählen Sie diese Operation, um einen Vorgang zu zwingen, einen Error Operation, wenn die Payload von der Jira API enthält einen Statuscode für „Nicht erfolgreich“. Wenn diese Option nicht ausgewählt ist (Standard), muss die Payload überprüft werden, um ihren Erfolg in Jira zu bestimmen.

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

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen auf, um die Konfiguration zu schließen, ohne die Änderungen in einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 2: Wählen Sie ein Objekt aus

Wählen Sie in diesem Schritt ein Objekt aus. Die einzelnen Elemente der Benutzeroberfläche werden unten beschrieben.

Jira-Suchaktivitätskonfiguration, Schritt 2

  • Objekt auswählen: In diesem Abschnitt werden die im Jira Endpoint verfügbaren Objekte angezeigt.

    • Ausgewähltes Jira Projekt: Das im vorherigen Schritt ausgewählte Jira-Projekt wird hier aufgelistet.

    • Ausgewähltes Jira Objekt: Nachdem ein Objekt ausgewählt wurde, wird es hier aufgelistet.

    • Suchen: Geben Sie den Wert einer beliebigen Spalte in das Suchfeld ein, um die Objektliste zu filtern. Die Suche berücksichtigt keine Groß- und Kleinschreibung. Wenn in der Tabelle bereits Objekte angezeigt werden, werden die Tabellenergebnisse mit jedem Tastendruck in Echtzeit gefiltert. Um Objekte während der Suche vom Endpoint neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie anschließend die Tabelle, wie unten beschrieben.

    • Aktualisieren: Lädt Objekte vom Jira Endpoint neu. Dies kann nützlich sein, wenn Objekte zu Jira hinzugefügt wurden. Diese Aktion aktualisiert alle Metadaten, die zum Erstellen der in der Konfiguration angezeigten Objekttabelle verwendet wurden.

    • Objekt auswählen: Klicken Sie in der Tabelle auf eine beliebige Zeile, um ein Objekt auszuwählen. Es kann nur ein Objekt ausgewählt werden. Die für jedes Objekt verfügbaren Informationen werden vom Jira Endpoint abgerufen:

      • Name: Der Name des Objekts.

      • Beschreibung: Die Beschreibung des Objekts.

    Tipp

    Wenn die Tabelle nicht mit verfügbaren Objekten gefüllt ist, wird die Jira Verbindung ist möglicherweise nicht erfolgreich. Stellen Sie sicher, dass Sie verbunden sind, indem Sie die Verbindung erneut öffnen und die Anmeldeinformationen erneut testen.

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

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 3: Einstellungen festlegen

Geben Sie in diesem Schritt die Suchkriterien an. Die einzelnen Elemente der Benutzeroberfläche werden unten beschrieben.

Jira-Suchaktivitätskonfiguration, Schritt 3

Tipp

Felder mit einem variablen Symbol Unterstützung bei der Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder mit einer öffnenden eckigen Klammer [ in das Feld oder klicken Sie auf das Variablensymbol, um eine Liste der vorhandenen Variablen anzuzeigen, aus denen Sie auswählen können.

  • JQL: Geben Sie die Suchkriterien mithilfe der Jira Abfrage ein (JQL) Syntax. globale Variablen werden in der JQL-Anweisung unterstützt.

    Hinweis

    Sie können das Feld JQL verwenden, um mehrere Projekte anzugeben (über das in [Schritt 1] angegebene Projekt hinaus).#step-1-enter-a-name-and-select-a-project)).

  • Erweitern (nur für Vorgänge und Projekte): Geben Sie eine durch Kommas getrennte Liste der Entitäten ein, die in der Antwort enthalten sein sollen. Diese Entitäten werden standardmäßig nicht zurückgegeben und können angegeben werden:

    Entität Beschreibung
    renderedFields Gibt im HTML-Format gerenderte Feldwerte zurück.
    names Gibt den Anzeigenamen jedes Felds zurück.
    schema Gibt das Schema zurück, das einen Feldtyp beschreibt.
    transitions Gibt alle möglichen Übergänge für das Problem zurück.
    operations Gibt alle möglichen Vorgänge für das Problem zurück.
    editmeta Gibt Informationen darüber zurück, wie jedes Feld bearbeitet werden kann.
    changelog Gibt eine Liste der letzten Aktualisierungen zu einem Problem zurück, sortiert nach Datum, beginnend mit der aktuellsten.

    Wichtig

    Wenn Sie in diesem Feld eine Entität angeben, müssen Sie das Schema bearbeiten (in Schritt 4), um jede Entität als Feld in das Schema einzuschließen. Andernfalls werden die Daten der Entität nicht in die Antwort aufgenommen.

    Notiz

    Dieses Feld funktioniert nur bei der Interaktion mit Jira-Projekten oder-Problemen (angegeben in Schritt 2).

  • Maximale Ergebnisse: Geben Sie die maximale Anzahl der Ergebnisse ein, die auf einer Seite zurückgegeben werden sollen. Wenn nicht angegeben, werden alle Datensätze für das ausgewählte Objekt ohne Seitennummerierung zurückgegeben.

  • Starten bei: Geben Sie den Index des ersten Elements ein, das auf der Seite zurückgegeben werden soll.

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

  • Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 4: Überprüfen der Datenschemata

Alle Anforderungs- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

Jira-Suchaktivitätskonfiguration, Schritt 4

  • Datenschemata: Diese Datenschemata werden von benachbarten Transformations übernommen und beim Transformation erneut angezeigt.

    Notiz

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

    Der Jira Konnektor verwendet die Jira REST API v3 für den Instanztyp Jira Cloud und Jira REST API v2 für den Instanztyp Jira On-Premise. Informationen zu den Schema und -feldern finden Sie in der API Dokumentation.

  • Aktualisieren: Generiert Schemas vom Jira Endpoint neu. Diese Aktion generiert ein Schema auch an anderen Stellen im Projekt neu, an denen auf dasselbe Schema verwiesen wird, z. B. in einer angrenzenden Transformation.

  • Bearbeiten: Hiermit gelangen Sie in den Editor für das Schema. Mit dem Editor können Sie Knoten und Felder hinzufügen, löschen, neu organisieren und deren Datentypen ändern. Alle neu hinzugefügten Knoten und Felder werden auf [0, 1]Kardinalität. Änderungen an den Datenschemata müssen für den Endpoint akzeptabel sein und sollten nur nach Konsultation der verfügbaren Dokumentation zum Endpoint vorgenommen werden. Nach der Bearbeitung eines Schema wird oben im entsprechenden Schema das Datum der letzten Bearbeitung angezeigt, um darauf hinzuweisen, dass das Schema manuell bearbeitet wurde. Durch Aktualisieren der Schemata werden diese auf ihre Standardstrukturen zurückgesetzt.

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

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

  • Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen auf, um die Konfiguration zu schließen, ohne die Änderungen in einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Nächste Schritte

Nachdem Sie eine Jira Such-Aktivität konfiguriert haben, schließen Sie die Konfiguration des Operation ab, indem Sie andere Aktivitäten oder Tools hinzufügen und konfigurieren als Operation. Sie können auch die Operation konfigurieren, darunter die Möglichkeit, Vorgänge im selben oder in verschiedenen Workflows miteinander zu verketten.

Menüaktionen für eine Aktivität sind über den Projektbereich und die Design-Canvas zugänglich. Weitere Informationen finden Sie unter Aktionsmenü“ in Connector-Grundlagen.

Jira Such-Aktivitäten können mit diesen Operation als Quelle verwendet werden:

Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Speicherort und verwenden Sie diesen temporären Speicherort dann in der Skriptfunktion.

Wenn Sie bereit sind, einsetzen und ausführen den Operation und validieren Sie das Verhalten, indem Sie die Operation.