Confluence Cloud Dokumentation

Jira Makro einfügen



Wenn deine Confluence Site mit einer Jira-Anwendung verbunden ist, kannst du Jira-Issues auf Confluence Seiten erstellen und anzeigen. Du kannst Confluence mit jeder Jira-Anwendung verbinden, einschließlich Jira Software und Jira Service Desk.


Was du mit dem Jira Makro tun kannst

Mit dem Jira Makro kannst du:

  • Eine Liste von Vorgängen auf deiner Seite anzeigen, basierend auf einer Jira Query Language (JQL) (Englisch)Suche, einem Filter oder einer URL.
  • Einen einzelnen Vorgang anzeigen.
  • Eine Anzahl von Vorgängen anzeigen.
  • Neue Vorgänge erstellen und sie auf deiner Seite anzeigen, ohne Confluence zu verlassen.


Verwende das Jira Makro

So fügst du ein Makro hinzu:

  1. Beim Bearbeiten klickst du in der Symbolleiste auf .
  2. Finde das Makro mithilfe seines Namens und wähle es aus.
  3. Richte es nach Bedarf ein.


Du kannst auch / auf der Seite eintippen, um die gleiche Liste aufzurufen, die du auch bei der Auswahl in der Symbolleiste siehst. Tippe weiter den Namen des Makros ein, um die Liste zu filtern.

So bearbeitest du ein Makro:

  1. Wähle den Makroplatzhalter aus.
  2. Klicke auf das Symbol Bearbeiten, um das Konfigurationsfenster zu öffnen.
  3. Richte die Einstellungen ein. Deine Änderungen werden während der Bearbeitung gespeichert.
  4. Setze die Bearbeitung der Seite fort und schließe das Panel.


Du kannst auch die Symbole Zurück zur Mitte, Verbreitern und Volle Breite auswählen, um die Breite einiger Makros anzupassen. Wähle das Mülleimersymbol aus, um das Makro zu entfernen.


Anzeige von Issues über eine Jira Query Language (JQL) Suche

Du kannst das Makro verwenden, um eine Tabelle mit Vorgängen auf deiner Seite anzuzeigen, die auf den Ergebnissen einer Suche mit der Jira Query Language (JQL) basiert.

JQL ist eine einfache Abfragesprache, die ähnlich wie SQL ist. Eine grundlegende JQL-Abfrage besteht aus einem Feld, gefolgt von einem Operator (z. B. = oder >), gefolgt von einem oder mehreren Werten oder Funktionen.

Beispiele:

  • Die folgende Abfrage findet alle Vorgänge im Projekt "TEST":

                project = "TEST"
  • Die folgende Abfrage findet alle Vorgänge in der Komponente "Dokumentation" des Projekts "CONF":

                project = CONF and component = documentation

Weitere Informationen zur JQL-Syntax findest du unter Erweiterte Suche (Englisch) in der Jira Software-Dokumentation.


So zeigst du eine Tabelle mit Vorgängen an, die auf einer JQL-Suche basieren:

  1. Füge das Jira Makro in deine Confluence Seite ein, wie oben beschrieben.
  2. Wähle einen Jira-Server neben der Schaltfläche Suchen.
  3. Wenn du dazu aufgefordert wirst, melde dich auf dem Jira-Server an.
  4. Gib die JQL-Abfrage in das Suchfeld ein.
  5. Klicke auf Suchen.
  6. Wenn du die Anzeige anpassen möchtest, wähle Anzeigeoptionen und passe die Spalten und die Anzahl der Probleme an, die in deiner Problemtabelle erscheinen sollen.
  7. Klicke auf Einfügen.



Anzeigen von Issues über eine Jira-URL

Du kannst jede der folgenden Jira-Anwendungs-URLs in das Jira Makro einfügen. Confluence wandelt die URL sofort in eine JQL-Suche um.

  • Eine beliebige URL für eine Vorgangssuche oder einen Filter.
  • Eine URL für einen einzelnen Vorgang.
  • Die URL der XML-Ansicht einer Suche.


Automatisch konvertieren: Du kannst URLs direkt in den Confluence-Editor einfügen (ohne den Makro-Browser aufzurufen). Confluence wandelt die URL dann automatisch in ein Jira Makro um.


Anzeige einer einzelnen Issue oder ausgewählter Issues

Um einen einzelnen Jira Vorgang anzuzeigen, wähle eine der folgenden Methoden aus:

  • Füge die URL des Vorgangs direkt auf der Confluence Seite ein. (Du brauchst den Makro-Browser nicht zu verwenden.) Confluence wandelt den Link automatisch in ein Jira Makro um.
  • Oder: Füge das Jira Makro wie oben beschrieben zur Seite hinzu und wähle Kürzlich gesehen aus, um die Vorgänge zu sehen, die du kürzlich besucht hast. Wähle ein Vorgang aus und klicke auf Einfügen.
  • Oder: Füge das Jira Makro wie oben beschrieben zu der Seite hinzu und füge die URL der Ausgabe in das Suchfeld des Makrobrowsers ein.
  • Oder: Füge das Jira Makro zur Seite hinzu, definiere deine Suchkriterien im Makro-Browser über JQL wie zuvor beschrieben und aktiviere dann das Kontrollkästchen neben der Ausgabe in den Suchergebnissen im Makro-Browser.


Du kannst wählen, ob du nur den Vorgangsschlüssel oder den Vorgangsschlüssel und eine Zusammenfassung anzeigen lassen willst. Markiere den Makro-Platzhalter und wähle Zusammenfassung anzeigen oder Zusammenfassung ausblenden aus. 


Um eine Teilmenge der Jira Vorgänge aus deinen Suchergebnissen anzuzeigen:

  1. Füge das Jira Makro zu deiner Seite hinzu.
  2. Definiere deine Suchkriterien im Makro-Browser über JQL, wie zuvor beschrieben.
  3. Aktiviere die Kontrollkästchen neben den gewünschten Vorgängen in den Suchergebnissen im Makro-Browser.


Anzeige der Anzahl der Issues

Du kannst dir die Anzahl der von deiner Suche zurückgegebenen Vorgänge anzeigen lassen, anstelle einer Tabelle mit den Vorgängen. Das Jira Makro zeigt die Anzahl der Vorgänge an, die mit der Suche in deiner Jira-Anwendung verknüpft sind.


So zeigst du die Anzahl der Vorgänge an:

  1. Füge das Jira Makro zu deiner Seite hinzu.
  2. Definiere deine Suchkriterien im Makro-Browser über JQL, wie oben beschrieben.
  3. Wähle die Anzeigeoptionen aus und klicke dann neben den Anzeigeoptionen auf Gesamtanzahl Vorgänge.
  4. Klicke auf Einfügen.


Eine neue Issue erstellen

Während du eine Confluence Seite bearbeitest, kannst du ein Vorgang in Jira erstellen und ihn auf deiner Confluence Seite anzeigen, ohne den Confluence Editor zu verlassen.


So erstellst du ein Vorgang und fügst es zu deiner Seite hinzu:

  1. Füge das Jira Makro zur Seite hinzu, wie es oben beschrieben wurde.
  2. Klicke auf Neuen Vorgang erstellen.
  3. Gib die Informationen zu deinem Jira Server, deinem Projekt und deinem Vorgang ein, wenn du dazu aufgefordert wirst.
  4. Klicke auf Einfügen.


Confluence sendet eine Anfrage an deine Jira-Anwendung, um den Vorgang zu erstellen, und zeigt den neu erstellten Vorgang auf deiner Seite an.


Einschränkungen

Das Jira Makro wird dich benachrichtigen, wenn es nicht in der Lage ist, einen Vorgang in dem ausgewählten Projekt zu erstellen. Das kann daran liegen, dass das Projekt ein erforderliches Feld, eine Feldkonfiguration oder eine andere Anpassung hat, die vom Jira Makro nicht unterstützt wird. In diesem Fall musst du den Vorgang direkt in deiner Jira-Anwendung erstellen.


Wiedergabe von HTML in Jira-Anwendungen

Formatierte Felder aus Jira können in Confluence angezeigt werden, wenn du eine Verknüpfung zwischen Confluence und Jira einrichtest. Andernfalls werden solche formatierten Felder in der Ausgabe des Jira Makros umgangen. Damit soll verhindert werden, dass bösartiger HTML-Code von einem nicht vertrauenswürdigen Jira-Server übermittelt wird. Am wahrscheinlichsten wirst du dies im Beschreibungsfeld bemerken.


Deaktivieren des Jira Makros

Die Funktionalität wird von einem Add-on (Plugin) namens "Jira Macros" bereitgestellt. Um das Makro auf deiner Instanz nicht verfügbar zu machen, kannst du das Add-on deaktivieren. Weitere Informationen findest du unter Deaktivieren und Aktivieren von Apps (Englisch).


Wiki Markup Beispiel


Wiki Markup wird nur im Legacy Editor unterstützt.

Wiki-Markup ist nützlich, wenn du ein Makro außerhalb des Editors hinzufügen musst, zum Beispiel als benutzerdefinierten Inhalt in der Seitenleiste, der Kopfzeile oder der Fußzeile eines Bereichs.

Makroname: jiraissues

Makrokörper: Keine.

            {jiraissues:anonymous=true|url=https://jira.atlassian.com/issues/?filter=41225}

Eine Reihe von zusätzlichen Parametern, die bei der Bearbeitung des Makros nicht verfügbar sind, sind im Speicherformat und im Wiki-Markup verfügbar.

Parameter Name

Erforderlich

Standard

Parameterbeschreibung und akzeptierte Werte

anonymous

Nein

Falsch

(false)

Wenn dieser Parameter auf true gesetzt ist, zeigt deine Jira-Anwendung nur die Vorgänge an, die eine uneingeschränkte Anzeige erlauben. Das heißt, die Vorgänge, die für anonyme Betrachter sichtbar sind. Wenn dieser Parameter weggelassen oder auf false gesetzt wird, hängen die Ergebnisse davon ab, wie dein Administrator die Kommunikation zwischen der Jira-Anwendung und Confluence konfiguriert hat. Standardmäßig zeigt Confluence nur die Vorgänge an, für die der Benutzer eine Berechtigung hat.

Hinweis: Dieser Parameter ist nur verfügbar, wenn du das Makro über Wiki-Markup oder durch Bearbeiten des Speicherformats der Seite einfügst. Der Makro-Browser bietet diesen Parameter nicht an.

baseurl

Nein

Der Wert des Parameters 'url'

Wenn du eine baseurl angibst, wird der Link in der Kopfzeile, der auf deine Jira-Anwendung zeigt, diese Basis-URL anstelle des Wertes des Parameters url verwenden. Das ist nützlich, wenn Confluence eine Verbindung zu Jira mit einer anderen URL herstellt als die, die von anderen Benutzern verwendet wird.

columns

Nein

Standardmäßig werden die folgenden Spalten angezeigt:

  • Schlüssel

  • Zusammenfassung
  • Type → S
  • Erstellt
  • Aktualisiert
  • Fällig
  • Bearbeiter
  • Autor
  • Priorität
  • Status
  • Lösung

Eine Liste von Jira-Spaltennamen, getrennt durch Semikolons (;). Du kannst viele Spalten einfügen, die von deiner Jira-Anwendung erkannt werden, einschließlich benutzerdefinierter Spalten.

Einige Spalten, z. B. solche, die von Jira berechnet werden müssen, wie "Arbeitsverhältnis" oder "Zeit bis zur Lösung", können in Confluence nicht angezeigt werden.

count

Nein

Falsch

(false)

Wenn dieser Parameter auf true gesetzt ist, wird in der Vorgangsliste die Anzahl der Vorgänge in Jira angezeigt. Die Anzahl wird mit deiner Jira Instanz verknüpft.

cache

Nein

on

Das Makro speichert die Vorgänge, die sich aus der Jira-Abfrage ergeben, in einem Cache. Wenn der Parameter cache auf off gesetzt ist, wird der relevante Teil des Caches bei jedem Neuladen des Makros geleert. (Der Wert false funktioniert ebenfalls und hat die gleiche Wirkung wie off).

Hinweis: Dieser Parameter ist nur verfügbar, wenn du das Makro über Wiki-Markup oder durch Bearbeiten des Speicherformats der Seite einfügst. Der Makro-Browser bietet diesen Parameter nicht an.

height

Nein

480 (wenn der Rendermodus dynamisch ist)

Die Höhe der Tabelle, die die Vorgänge anzeigt, in Pixeln.
Beachte, dass diese Höhenangabe in den folgenden Situationen ignoriert wird:

  • Wenn der Parameter renderMode (siehe unten) auf static eingestellt ist.
  • Wenn die Vorgänge in einem PDF- oder Word-Dokument, in einer E-Mail-Nachricht oder in einem RSS-Feed angezeigt werden.

Hinweis: Dieser Parameter ist nur verfügbar, wenn du das Makro über Wiki-Markup oder durch Bearbeiten des Speicherformats der Seite einfügst. Der Makro-Browser bietet diesen Parameter nicht an.

renderMode

Nein

static

Wenn der Wert dynamic ist, bietet das Makro Jira Issues eine interaktive Anzeige, die du wie folgt bearbeiten kannst:

  • Klicke auf die Spaltenüberschriften, um die Ausgabe zu sortieren.
  • Ziehe die Spalten per Drag & Drop in eine andere Reihenfolge.
  • Vorübergehend eine Spalte aus der Anzeige entfernen.
  • Du kannst dir eine Seite mit Vorgängen auf einmal ansehen, um schneller reagieren zu können.

Mit dem Wert static werden die dynamischen Anzeigefunktionen deaktiviert.

Hinweis: Dieser Parameter ist nur verfügbar, wenn du das Makro über Wiki-Markup oder durch Bearbeiten des Speicherformats der Seite einfügst. Der Makro-Browser bietet diesen Parameter nicht an.

title

Nein

Jira Vorgänge

(Jira Issues)

Mit diesem Parameter kannst du den Titeltext oben in der Tabelle der Vorgänge anpassen. Wenn du zum Beispiel den Titel "Bugs-to-fix" einstellst, wird der Standardtext "Jira Issues" ersetzt. So kann die Liste der angezeigten Vorgänge mit mehr Kontext versehen werden.

Hinweis: Dieser Parameter ist nur verfügbar, wenn du das Makro über Wiki-Markup oder durch Bearbeiten des Speicherformats der Seite einfügst. Der Makro-Browser bietet diesen Parameter nicht an.

url

Ja

Keine

Die Adresse der XML-Ansicht der von dir ausgewählten Vorgänge.

Hinweis: Wenn die URL im Parameter url kein tempMax Argument enthält, ist der Wert von tempMax standardmäßig 500. Wenn dein Jira Server Version 3.12 oder älter ist, bedeutet das, dass das Jira Makro maximal 500 Vorgänge zurückgibt. Wenn dein Jira Server Version 3.13 oder neuer ist, bedeutet ein Wert von 500, dass das Jira Makro maximal 500 Vorgänge pro Seite zurückgibt.

width

Nein

100%

Die Breite der Tabelle, in der die Vorgänge angezeigt werden. Kann als Prozentsatz (%) oder in Pixel (px) angegeben werden.

Hinweis: Dieser Parameter ist nur verfügbar, wenn du das Makro über Wiki-Markup oder durch Bearbeiten des Speicherformats der Seite einfügst. Der Makro-Browser bietet diesen Parameter nicht an.





Zurück zum Hauptmenü   Nächstes Thema  







Confluence

Diese Seite wurde zuletzt am 06.03.2023 geändert.