Jira Makro
Wenn Ihre Confluence-Instanz mit einer Jira-Instanz verbunden ist, können Sie mit dem Jira Makro (Jira Issues macro) Jira Vorgänge auf Ihren Confluence Seiten erstellen und anzeigen. Sie können Confluence an jegliche Jira-Applikation anbinden, inkl. Jira Software und Jira Service Desk.
Bevor Sie dieses Makro benutzen können, müssen Ihre Confluence- und Jira-Applikationen via Application Links verbunden sein. Nutzer, die die Seite ansehen, können Vorgänge von der Jira-Instanz sehen, die öffentlichen Zugang haben. Wenn Ihre Jira-Applikation Einschränkungen besitzt (wenn Nutzer also Berechtigungen benötigen, um Vorgänge anzusehen), müssen diese Nutzer sich vor dem Ansehen der Diagramme authentifizieren.
Was kann mit dem Jira Makro gemacht werden?
Mit dem Jira Makro können Sie:
- Eine Liste von Jira Vorgängen auf Ihrer Confluence Seite anzeigen, die auf einer JIRA Query Language (JQL) Suche, einem Filter oder einer URL basiert.
- Einen einzigen Vorgang anzeigen.
- Mehrere Vorgängen anzeigen.
- Neue Vorgänge erstellen und Vorgänge auf der Seite anzeigen, ohne Confluence zu verlassen.
Anwendung des Jira Makros
So fügen Sie das Jira Makro auf einer Seite ein:
- Im Bearbeitungsmodus der Seite klicken Sie oben im Editor Menü auf das
Symbol (Weiteren Inhalt einfügen) und dann auf Andere Makros. - Tippen Sie den Makro Namen oder einen Teil davon ein und suchen Sie das gewünschte Makro aus. Klicken Sie auf das Makro.
- Wählen Sie den gewünschten Jira-Server aus. Wenn Sie mehrere Jira-Server mit Confluence verlinkt haben, wählen Sie aus dem Drop-Down Menü aus.
- Suchen Sie nach Vorgängen. Sie können eine JQL-Abfrage eingeben oder eine Jira-URL direkt ins Suchfeld eingeben.
- Klicken Sie auf Vorschau, um das Diagramm zu generieren.
- Wählen Sie Anzeigeoptionen aus, um Parameter für das Diagramm eingeben zu können.
- Klicken Sie auf Einfügen.
Mehr Information zum Auswählen des Vorgangs unter: Jira Makro.
Schneller geht's mit der Autovervollständigung:
Tippen Sie die sich öffnende geschweifte Klammer '{' und den Beginn des Names des Makros, um eine Liste vorgeschlagener Makros zu sehen.
Editieren eines existierenden Makros
Um ein existierendes Makro zu bearbeiten:
Klicken Sie auf den Makro Platzhalter und dann auf Bearbeiten. Dieses öffnet den Dialog der Makro Details und Sie können die Makro Parameter (wenn vorhanden) bearbeiten.
Vorgänge via der Jira Query Language (JQL) Suche anzeigen
Sie können das Makro benutzen, um eine Liste von Vorgängen auf Ihrer Seite anzuzeigen, die auf den Ergebnissen einer Jira Query Language (JQL) Suche basiert.
JQL ist eine einfache Suchabfrage, ähnlich wie SQL. Eine einfache JQL-Suche basiert auf einem Feld, gefolgt von einem Operator (wie = oder >), gefolgt von einem oder mehreren Werten oder Funktionen.
Beispiele:
Die folgende Suche findet alle Vorgänge im "TEST" Projekt:
project = "TEST"Diese Suche findet alle Vorgänge in der "documentation" Komponente des "CONF" Projekts:
project = CONF and component = documentation
Sie finden mehr Information über die JQL-Syntax auf dieser Seite unserer Jira Software Dokumentation auf Deutsch oder unter Advanced searching direkt bei Atlassian.
Eine Liste basiert auf einer JQL-Suche anzeigen lassen:
- Fügen Sie das Jira Makro ein, wie hier oben beschrieben.
- Wählen Sie einen Jira-Server im Suchfeld ein.
- Wenn aufgefordert, loggen Sie sich im Jira-Server ein.
- Geben Sie die JQL-Suche in der Suchbox ein.
- Klicken Sie auf Suchen.
- Wenn Sie die Ausgabe verändern möchten, klicken Sie auf Anzeigeoptionen und modifizieren Sie die Parameter. Dann klicken Sie auf Einfügen.
Vorgänge via einer Jira URL anzeigen
Sie können jeder dieser Jira-Applikations URL's in das Jira Makro einfügen. Confluence wandelt die URL automatisch in eine JQL-Suche um:
- Jegliche URL für eine Vorgangs-Suche oder einen Filter.
- Eine URL für einen einzigen Vorgang.
- Die URL der XML-Ansicht einer Suche.
Automatische Konvertierung: Sie können URL's auch direkt in den Confluence-Editor einfügen (also ohne den Makro Browser aufzurufen). Confluence wandelt die URL automatisch in ein Jira Makro um.
Einzelner Vorgang
Um nur einen Jira Vorgang anzeigen zu lassen, wählen Sie eine der folgenden Methoden aus:
- Fügen Sie die URL des Vorgangs direkt auf der Confluence Seite ein (ohne das Makro zu öffnen). Confluence konvertiert den Link automatisch in ein Jira Issue Macro.
- Oder: fügen Sie wie oben beschrieben, das Jira Makro auf der Seite ein und wählen Sie Kürzlich angezeigt aus, um die Vorgänge zu sehen, die sie vor Kurzem bearbeitet oder angesehen haben.
- Oder: fügen Sie wie oben beschrieben, das Jira Makro auf der Seite ein und kopieren Sie die URL des Vorgangs in die Suchbox des Makro-Browsers.
- Oder: fügen Sie das Jira Makro auf der Seite ein und definieren Sie ihr Suchkriterium im Makro-Browser via JQL, wie weiter oben beschrieben. Dann wählen Sie im Makro-Browser die Checkbox neben dem Vorgang der Suchergebnisse aus.
Sie können auswählen, nur den Vorgangs-Schlüssel oder den Vorgangs-Schlüssel und eine Zusammenfassung anzeigen zu lassen.
Um nur einen Teil der Jira Vorgänge Ihrer Suchergebnisse anzuzeigen:
- Fügen Sie das Jira Makro auf Ihrer Seite ein.
- Definieren Sie die Suchkriterien im Marko-Browser via JQL, wie weiter oben beschrieben.
- Wählen Sie die Checkboxen im Makro-Browser neben den benötigen Vorgängen der Suchergebnisse aus.
Gesamtzahl Vorgänge
Sie können mehrere Vorgänge der Suchergebnisse auswählen, anstatt eine ganze Liste der Vorgänge. Das Jira Makro zeigt eine Anzahl von Vorgängen an, die sich aus der Suche in der Jira-Applikation ergab.
Um mehrere Vorgänge anzuzeigen:
- Fügen Sie das Jira Makro auf Ihrer Seite ein.
- Definieren Sie die Suchkriterien im Marko-Browser via JQL, wie weiter oben beschrieben.
- Wählen Sie neben Anzeigen als Anzeigeoptionen aus und dann Gesamtzahl Vorgänge aus.
- Klicken Sie auf Einfügen.
Neuen Vorgang erstellen
Während Sie an einer Confluence Seite arbeiten, können Sie einen Jira Vorgang erstellen und diesen auf der Confluence Seite anzeigen lassen, ohne den Confluence Editor zu verlassen.
Einen Vorgang erstellen und diesen auf der Seite anzeigen:
- Fügen Sie das Jira Makro auf Ihrer Seite ein.
- Wählen Sie Neuen Vorgang erstellen aus.
- Füllen Sie die benötigte Information aus (Projekt, Vorgangstyp, Zusammenfassung).
- Klicken Sie auf Einfügen.
Confluence schickt eine Anfrage an Ihre Jira-Applikation, um den Vorgang zu erstellen und zeigt dann den neu erstellten Vorgang auf Ihrer Seite an.
Confluence will send a request to your Jira application, to create the issue, then display the newly created issue on your page.
Einschränkungen
Das Jira Marko zeigt Ihnen nicht an, falls es nicht möglich war, einen Vorgang im ausgewählten Projekt zu erstellen. Das kann sein, wenn das Projekt ein besonderes Feld benötigt, die Feld-Konfiguration oder andere Aspekte nicht vom Jira Makro unterstützt werden. In diesem Fall müssen Sie den Vorgang direkt in Ihrer Jira-Applikation erstellen.
Konfiguration von Applikations-Links, um beschränkte Vorgänge anzeigen zu können
Bevor Sie dieses Makro benutzen können, müssen Ihre Confluence- und Jira-Instanzen via Application Links verknüpft werden.
Wenn die Jira-Instanz es anonymen Nutzern erlaubt, Vorgänge zu sehen, müssen Sie einen Applikations-Link konfigurieren, jedoch muss keine eingehende oder ausgehende Authentifizierung zwischen Jira und Confluence konfiguriert werden. Nutzer, die die Confluence Seite sehen, können auch die Vorgänge mit öffentlichen Zugriff sehen.
Wenn Ihre Jira Seite beschränkt ist oder einige Jira Projekte oder Vorgänge nur von bestimmten Leuten angesehen werden, werden die Nutzer aufgefordert, sich einzuloggen und sich zu authentifizieren, um die beschränkten Vorgänge sehen zu können.
Rendern von HTML aus Jira-Anwendungen
In Confluence können formatierte Felder aus Jira angezeigt werden, wenn Sie einen Confluence-zu-Jira Applikations-Link hergestellt haben. Wenn nicht, werden solche formatierten Felder nicht mit in der Anzeige des Jira Makros eingeschlossen. Dies soll verhindern, dass HTML Malware von einem nicht vertrauenswürdigen Jira-Server bereitgestellt wird. Sie werden dieses am meisten beim Feld der Zusammenfassung sehen.
Dieses Beispiel zeigt, wie eine Zusammenfassungs-Spalte in Jira angezeigt werden kann:
Zusammenfassung
Dieses ist
- die Zusammenfassung
- meines Vorgangs
Wenn es keinen Applikations-Link zwischen Jira und Confluence gibt, wird die Zusammenfassung im Jira Makro so aussehen:
Zusammenfassung
<p>Dieses ist<ul><li>die Zusammenfassung</li><li>meines Vorgangs</li></ul></p>
Hinweise
HTTPS: Das Jira-Diagramm Makro kann auf eine Jira-Instanz, die unter SSL läuft zugreifen, solange der Confluence-Server so konfiguriert ist, dass er das Jira SSL-Zertifikat akzeptiert. Siehe dazu: Verbindung zu LDAP oder Jira-Applikationen oder anderen Services via SSL.
Personendefinierte Felder können der Tabelle einfach als Spaten hinzugefügt werden, indem Sie den Namen des Feldes ohne Anführungsstriche benutzen. Frühere Versionen des Makros benötigten die Benutzung der Feld ID, wie z.B. customfield_10100.
Beispiel eines Wiki Markups
Dieses Beispiel ist hilfreich, wenn Sie ein Makro ausserhalb des Editors, z.B. als benutzerdefinierten Inhalt in der Randleiste, der Kopf- oder Fußzeile, hinzufügen möchten.
Macro name: jiraissues
Macro body: None.
This example uses a Jira filter.
{jiraissues:anonymous=true|url=https://jira.atlassian.com/issues/?filter=41225}
Mehrere zusätzliche Parameter sind nicht via Makro-Browser, jedoch im Storage-Format und im Wiki-Markup einsetzbar:
Name | Benötigt | Standard-Einstellung | Parameter Beschreibung und akzeptierte Werte |
|---|---|---|---|
| Ja |
| Wenn dieser Parameter angeklickt ist, erlaubt Ihre Jira-Applikation nur die Anzeige der Vorgänge, die uneingeschränktes Ansehen erlauben. Das bedeutet, wenn die Vorgänge für anonyme Besucher einsehbar sind. Wenn dieser Parameter nicht angeklickt oder nicht beachtet wird, basieren die Ergebnisse darauf, wie Ihr Admin die Kommunikation zwischen den Jira- und Confluence-Instanzen konfiguriert hat. Standardgemäß wird Confluence nur die Vorgänge anzeigen, für die der Nutzer die Berechtigung zum Ansehen hat. Hinweis: dieser Parameter ist nur benutzbar, wenn Sie das Makro via Wiki Markup oder durch Editieren des Storage-Formates auf der Seite eingefügt haben. Der Makro-Browser bietet diesen Parameter nicht an. |
| Ja | Der Wert des 'url' Paramaters | Wenn Sie einen 'baseurl' angeben, wird der Link zum Header, der zur Jira-Applikation geht, diese Basis URL anstatt des Wertes des 'url' Parameters benutzen. Das ist hilfreich, wenn Confluence sich mit Jira mit einer anderen ULA verbindet, als die, die andere benutzen. |
| Ja | Standardmäßig werden die folgenden Spalten angezeigt:
| Das ist eine Liste von Spalten Namen, getrennt durch Semikolons (;). Sie können viele Spalten, die von Ihrer Jira-Applikation benutzt werden, benutzen, inklusive selbst definierter Spalten. Einige Spalten, wie solche die von Jira erst ausgerechnet werden müssen (wie z.B. 'work ratio' oder 'time to resolution') können nicht in Confluence angezeigt werden. |
| Nein |
| Wenn dieser Parameter angeklickt wird, wird die Vorgangsliste die Anzahl der Jira Vorgänge anzeigen. Die Zählung ist mit Ihrer Jira-Instanz verbunden. |
| Nein |
| Das Makro behält ein Cache der Vorgänge bei, die sich aus der Jira-Abfrage ergeben. Wenn der 'cache' Parameter auf 'off' steht, wird der relevante Teil des Caches jedes Mal, wenn das Marko neu geladen wird, gelöscht. (Der Wert 'false' funktioniert genauso wie 'off'.) Hinweis: dieser Parameter ist nur benutzbar, wenn Sie das Makro via Wiki Markup oder durch Editieren des Storage-Formates auf der Seite eingefügt haben. Der Makro-Browser bietet diesen Parameter nicht an. |
| Nein |
| Die Höhe in Pixel der Tabelle, die die Vorgänge anzeigt. Bitte beachten Sie, dass die Höhen-Einstellung in diesen Situationen nicht gewährleistet wird:
Hinweis: dieser Parameter ist nur benutzbar, wenn Sie das Makro via Wiki Markup oder durch Editieren des Storage-Formates auf der Seite eingefügt haben. Der Makro-Browser bietet diesen Parameter nicht an. |
| Nein |
| Wenn der Wert auf 'dynamic' steht, bietet das Jira Makro eine interaktive Anzeige an, die Nutzer wie folgt bearbeiten können:
Wenn der Wert 'static' ausgewählt wird, werden die dynamischen Features deaktiviert. Hinweis: dieser Parameter ist nur benutzbar, wenn Sie das Makro via Wiki Markup oder durch Editieren des Storage-Formates auf der Seite eingefügt haben. Der Makro-Browser bietet diesen Parameter nicht an. |
| Nein | Jira Vorgänge | Sie können den Text des Titels oben auf der Liste der Vorgänge mit diesem Parameter einstellen. Z.B., wenn Sie den Titel auf 'Bugs-to-fix' einstellen, wird der Standard-Text 'Jira Issues' ersetzt. Dieses kann helfen, die angezeigte Liste verständlicher zu machen. Hinweis: dieser Parameter ist nur benutzbar, wenn Sie das Makro via Wiki Markup oder durch Editieren des Storage-Formates auf der Seite eingefügt haben. Der Makro-Browser bietet diesen Parameter nicht an. |
| Ja | keine | Die URL der XML-Ansicht der von Ihnen ausgewählten Vorgänge. Hinweis: Wenn die URL im 'url' Parameter kein tempMax Argument enthält, wird der Wert des tempMax standardgemäß mit 500 benutzt. Wenn Ihre Jira-Version 3.12 oder früher ist, wird das Makro maximal 500 Vorgänge anzeigen. Ab Version 3.13, bedeutet das, dass ein Wert von 500 maximal 500 Seiten pro Seite ausgibt. |
| Nein | 100% | Das ist die Breite der Tabelle, die die Vorgänge anzeigt. Diese kann als Prozentsatz (%) oder in Pixeln (px) angegeben werden. Hinweis: dieser Parameter ist nur benutzbar, wenn Sie das Makro via Wiki Markup oder durch Editieren des Storage-Formates auf der Seite eingefügt haben. Der Makro-Browser bietet diesen Parameter nicht an. |
Übersicht aller Confluence Makros
Auf dieser Seite finden Sie eine Übersicht aller im Standard von Confluence enthaltenden Makros und allgemeine Informationen über die Anwendung von Makros.