Zum Inhalt springen

Jira-Suchaktivität

Einführung

Eine Jira Such-Aktivität, die ihre Jira-Verbindung nutzt, ruft Objektdaten aus einem Jira-Projekt ab und ist als Quelle gedacht, um Daten in einem Vorgang bereitzustellen.

Erstellen einer Jira-Suchaktivität

Eine Instanz einer Jira Such-Aktivität wird aus einer Jira-Verbindung unter Verwendung des Aktivitätstyps Suche 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 Jira Such-Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer Jira-Suchaktivität

Befolgen Sie diese Schritte, um eine Jira Such-Aktivität zu konfigurieren:

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

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

Jira-Suchaktivitätskonfiguration Schritt 1

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

  • Projekt auswählen: In diesem Abschnitt werden die in der Jira-Schnittstelle verfügbaren Projekte angezeigt.

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

    • Suche: Geben Sie den Wert einer beliebigen Spalte in das Suchfeld ein, um die Liste der Projekte zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich. Wenn Projekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Projekte von der Schnittstelle beim Suchen neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

    • Aktualisieren: Lädt Projekte von der Jira-Schnittstelle 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 werden.

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

      • Name: Der Name des Projekts.

      • Beschreibung: Die Beschreibung des Projekts.

    Tipp

    Wenn die Tabelle nicht mit verfügbaren Projekten gefüllt wird, könnte die Jira-Verbindung nicht erfolgreich sein. 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:

    • Operation bei Fehler abbrechen: Wählen Sie diese Option, um eine Operation zu zwingen, einen Fehler Betriebsstatus zurückzugeben, wenn die Antwortlast von der Jira-API einen nicht erfolgreichen Statuscode enthält. Wenn diese Option nicht ausgewählt ist (Standard), muss die Antwortlast überprüft werden, um ihren Erfolg in Jira zu bestimmen.

  • 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 fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Wählen Sie ein Objekt

In diesem Schritt wählen Sie ein Objekt aus. Jedes Benutzeroberflächenelement dieses Schrittes wird unten beschrieben.

Jira-Suchaktivitätskonfiguration Schritt 2

  • Wählen Sie ein Objekt: In diesem Abschnitt werden die im Jira-Endpunkt verfügbaren Objekte angezeigt.

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

    • Ausgewähltes Jira-Objekt: Nach der Auswahl eines Objekts wird es hier aufgelistet.

    • Suche: Geben Sie den Wert einer Spalte in das Suchfeld ein, um die Liste der Objekte zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich. Wenn Objekte bereits in der Tabelle angezeigt werden, werden die Tabellenergebnisse in Echtzeit mit jedem Tastendruck gefiltert. Um Objekte beim Suchen vom Endpunkt neu zu laden, geben Sie Suchkriterien ein und aktualisieren Sie dann, wie unten beschrieben.

    • Aktualisieren: Lädt Objekte vom Jira-Endpunkt 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 werden.

    • Ein Objekt auswählen: Klicken Sie innerhalb der Tabelle auf eine beliebige Stelle in einer 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-Endpunkt abgerufen:

      • Name: Der Name des Objekts.

      • Beschreibung: Die Beschreibung des Objekts.

    Tipp

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

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

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

  • Änderungen verwerfen: Nach dem Vornehmen von Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 3: Einstellungen angeben

In diesem Schritt geben Sie die Suchkriterien an. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

Jira-Suchaktivitätskonfiguration Schritt 3

Tipp

Felder mit einem Variablen-Symbol 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-Symbol klicken, um eine Liste der vorhandenen Variablen anzuzeigen, aus der Sie auswählen können.

  • JQL: Geben Sie die Suchkriterien unter Verwendung der Jira-Abfragesprache (JQL) Syntax ein. Globale Variablen werden in der JQL-Anweisung unterstützt.

    Hinweis

    Sie können das Feld JQL verwenden, um mehrere Projekte anzugeben (über das im Schritt 1 angegebene Projekt hinaus).

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

    Entität Beschreibung
    renderedFields Gibt die Feldwerte im HTML-Format zurück.
    names Gibt den Anzeigenamen jedes Feldes 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 Operationen 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 eines Problems zurück, sortiert nach Datum, beginnend mit der aktuellsten.

    Wichtig

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

    Hinweis

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

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

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

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

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

  • Änderungen verwerfen: Klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen, die an einem Schritt vorgenommen wurden, zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 4: Überprüfen der Datenschemas

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

Jira-Suchaktivitätskonfiguration Schritt 4

  • Datenschemas: Diese Datenschemas werden von benachbarten Transformationen geerbt und während der Transformationszuordnung erneut angezeigt.

    Hinweis

    Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.

    Der Jira-Connector verwendet die Jira REST API v3 für den Jira Cloud Instanztyp und die Jira REST API v2 für den Jira On-premise Instanztyp. Weitere Informationen zu den Schema-Knoten und -Feldern finden Sie in der API-Dokumentation.

    Hinweis

    Für Jira Cloud Instanzen hat Atlassian seinen JQL (POST) API-Endpunkt eingestellt. Ab der Harmony 11.50 Version verwendet die Suche-Aktivität nun die JQL erweiterte Suche (POST). Siehe Atlassians Änderungsprotokoll für Unterschiede zwischen den neuen und alten API-Endpunkten.

  • Aktualisieren: Regeneriert Schemata vom Jira-Endpunkt. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, wo dasselbe Schema referenziert wird, wie in einer benachbarten Transformation.

  • Bearbeiten: Ermöglicht den Zugriff auf den Editor für das Datenschema. Der Editor ermöglicht es, Knoten und Felder hinzuzufügen, zu löschen und neu anzuordnen sowie deren Datentypen zu ändern. Alle neu hinzugefügten Knoten und Felder sind auf [0, 1] Kardinalität eingestellt. Änderungen an den Datenschemata müssen für den Endpunkt akzeptabel sein und sollten nur nach Konsultation der verfügbaren Dokumentation für den Endpunkt vorgenommen werden. Nach dem Bearbeiten des Schemas wird ein Datum der letzten Bearbeitung oben im entsprechenden Schema angezeigt, um anzuzeigen, dass das Schema manuelle Änderungen erfahren hat. Das Aktualisieren der Schemata setzt die Schemata auf ihre Standardstrukturen zurück.

  • 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: Nach dem Vornehmen von Änderungen klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine Jira Suche-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration der Operation, indem Sie andere Aktivitäten oder Werkzeuge als Operation Schritte hinzufügen und konfigurieren. Sie können auch die Betriebseinstellungen konfigurieren, die die Möglichkeit umfassen, Operationen 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.

Jira Suche-Aktivitäten können als Quelle mit diesen Betriebsmustern verwendet werden:

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 Betrieb und validieren Sie das Verhalten, indem Sie die Betriebsprotokolle überprüfen.