Aus einem Jira-Dashboard importieren
Exportelier kann ein Jira-Dashboard lesen und daraus einen Report bauen. Sie wählen ein Dashboard, Exportelier zeigt Gadget für Gadget, was es verstanden hat, Sie ergänzen, was Jira nicht herausgegeben hat — und erhalten einen ganz gewöhnlichen, bearbeitbaren Report.
Zwei Punkte sollten Sie vorher kennen, denn sie prägen alles Weitere auf dieser Seite.
Exportelier importiert die Konfiguration des Dashboards — welcher Filter, welches Feld, welcher Diagrammtyp — und baut sie aus eigenen Komponenten neu auf. Das Ergebnis ist kein Screenshot, keine pixelgenaue Kopie und keine eingebettete Jira-Seite. Spaltenbreiten, Gadget-Rahmen und exakte Abstände werden nicht reproduziert, weil Jiras öffentliche API sie nicht ausgibt.
Atlassian garantiert nicht, dass die Einstellungen eines eingebauten Gadgets über eine öffentliche API lesbar sind. Ist eine Einstellung nicht lesbar, bittet Exportelier Sie, sie auszuwählen. Es rät nie, welchen Filter oder welches Feld Sie gemeint haben.
Was importiert werden kann
| Jira-Gadget | Wird zu | Hinweise |
|---|---|---|
| Filter Results | Vorgangstabelle | Übernimmt die gewählten Spalten und ihre Reihenfolge |
| Pie Chart | Kategoriediagramm (Kreis) | Nutzt den Statistiktyp des Gadgets |
| Work Item Statistics | Kategoriediagramm (Balken) | Nutzt den Statistiktyp des Gadgets |
| Two Dimensional Filter Statistics | Matrix | Nutzt beide Achsenfelder |
| Created vs. Resolved Chart | Zeitreihendiagramm | Übernimmt Berichtszeitraum und Rückschau des Gadgets — siehe die Grenzen unten |
| Sprint Burndown | — | Benötigt historische Sprintdaten, die Exportelier noch nicht mitbringt |
| Alles andere | — | Wird benannt und ausgeschlossen, nie stillschweigend verworfen |
Jedes Gadget auf dem Dashboard erhält genau einen Status:
- Bereit — erkannt, und alles Benötigte war lesbar.
- Reparatur nötig — erkannt, aber Sie müssen eine fehlende Einstellung ergänzen.
- Später verfügbar — erkannt, aber die passende Exportelier-Komponente gibt es noch nicht. Sprint Burndown fällt hierunter.
- Nicht unterstützt — ein Drittanbieter- oder unbekanntes Gadget. Es wird für Sie benannt, nicht versteckt.
- Fehler — Jira hat Exportelier das Lesen verwehrt, oder das Gelesene war widersprüchlich. Dieser Status blockiert den Import, bis Sie es in Jira beheben.
Erkannt wird über die technische Identität des Gadgets, nie über seinen Titel. Ein umbenanntes Gadget oder ein anderssprachiges Jira ändert nichts daran, was Exportelier daraus macht — und ein eigenes Gadget „Pie Chart" zu nennen, macht es nicht zu einem.
Was ein Created-vs-Resolved-Diagramm zeigt
Ein importiertes Created-vs-Resolved-Diagramm zählt die Erstellungs- und Lösungsdaten der Vorgänge, die sein gespeicherter Filter heute liefert. Es rekonstruiert nicht, welche Vorgänge der Filter früher geliefert hat.
Das ist wichtig, wenn sich die Filtertreffer geändert haben. Wurde ein Vorgang aus dem Projekt verschoben, das der Filter abdeckt, verschwindet er aus allen Buckets — auch aus denen vor der Verschiebung. Jiras eigenes Gadget verhält sich aus demselben Grund genauso, aber man sollte es wissen, bevor man zwei Exporte aus verschiedenen Monaten vergleicht.
Drei weitere Abweichungen sind möglich; jede wird im Vollständigkeitshinweis des Berichts genannt, wenn sie zutrifft:
- Berichtszeitraum. Täglich, wöchentlich und monatlich werden exakt übernommen. Stündlich wird täglich, quartalsweise und jährlich werden monatlich — die Summen bleiben gleich, nur die Breite der Buckets ändert sich.
- Die Trendlinie ungelöster Vorgänge. Jira kann zusätzlich eine dritte Linie für offene Vorgänge über die Zeit zeichnen. Exportelier zeigt nur die Reihen „Erstellt“ und „Gelöst“.
- Rückschau. Ein Zeitraum länger als 366 Tage wird auf 366 Tage gekürzt.
Alles andere — Filter, kumulative Darstellung, die Zahlen selbst — wird unverändert übernommen, und Sie können jede dieser Einstellungen anschließend im Designer bearbeiten.
Der Import
- Öffnen Sie Reports und wählen Sie Aus Jira-Dashboard importieren.
- Wählen Sie ein Dashboard. Hier erscheinen nur Dashboards, die Jira Ihnen ohnehin zeigt — Site-Admin in Exportelier zu sein, erweitert diese Liste nicht.
- Lesen Sie die Analyse. Jedes Gadget ist mit seinem Status aufgeführt.
- Reparieren Sie, was zu reparieren ist. Filter und Felder wählen Sie über die gewohnten Auswahlfelder; ein Feld für rohes JQL gibt es bewusst nicht.
- Prüfen Sie die Vollständigkeit. Alles, was wegfällt, ist namentlich aufgeführt, und Sie müssen die Ausschlüsse ausdrücklich bestätigen, bevor der Report angelegt werden kann.
- Legen Sie den Report an. Er öffnet sich im normalen Designer, vollständig bearbeitbar.
Alles, was noch Reparatur nötig oder Fehler ist, blockiert das Anlegen. Exportelier verweigert lieber, als einen Report zu erzeugen, der ein halbes Dashboard stillschweigend unterschlägt.
Der Vollständigkeitshinweis
Jeder importierte Report beginnt mit einem Vollständigkeitshinweis — einer echten Komponente im Dokument, nicht einem Hinweis in der Oberfläche. Er nennt das Quell-Dashboard, den Importzeitpunkt, wie viele Gadgets des Dashboards enthalten sind und jedes Gadget, das es nicht ist, mit Titel.
Bei vollständigem Import ist es ein Informationshinweis, bei Ausschlüssen eine Warnung. Er erscheint in PDF, Word und Markdown gleichermaßen.
Solange der Report mit seinem Import verknüpft ist, verwaltet Exportelier den Hinweis: Das übrige Layout können Sie frei umbauen, den Hinweis aber weder löschen noch umschreiben. Wird er dennoch entfernt oder verändert, lässt sich der Report nicht exportieren — ein Dokument, das ein Dashboard abzubilden behauptet und dabei stillschweigend etwas auslässt, ist schlechter als gar kein Dokument.
Wenn Sie einen Report ohne Hinweis möchten, duplizieren Sie ihn. Ein Duplikat ist ein gewöhnlicher Report ohne Import dahinter und ohne verwalteten Hinweis.
Mit dem Dashboard Schritt halten
Der Import ist eine Momentaufnahme der Konfiguration des Dashboards. Die Daten bleiben live: Ein Report liest seine gespeicherten Filter beim Export erneut, die Zahlen sind also auch Monate nach dem Import aktuell.
Was sich nicht von selbst aktualisiert, sind Layout und Konfiguration. Fügt jemand in Jira ein Gadget hinzu oder richtet eines auf einen anderen Filter aus, arbeitet Ihr Report unverändert weiter, bis Sie etwas anderes bestimmen.
Öffnen Sie den Report und nutzen Sie Auf Änderungen prüfen. Exportelier liest das Dashboard erneut und ordnet jedes Gadget als hinzugefügt, entfernt, verschoben, konfigurationsgeändert oder unverändert ein. Erneut importieren wendet das dann an:
- unveränderte und verschobene Gadgets behalten, was sie haben;
- was Sie selbst zum Report hinzugefügt haben, bleibt unangetastet;
- geänderte und hinzugefügte Gadgets erhalten frischen Inhalt;
- ein Gadget, dessen neue Konfiguration sich nicht automatisch auflösen lässt, stoppt den erneuten Import und geht in die Reparatur, statt Ihre Arbeit mit einer Vermutung zu überschreiben;
- ein Gadget, das als „später verfügbar“ ausgeschlossen war und das eine neuere Exportelier-Version importieren kann, erscheint als geändert, und der Re-Import hängt es ans Ende des Berichts an. Bestehende Berichte erhalten nie allein durch ein Release eine neue Komponente — Sie müssen es anstoßen.
Vor jedem erneuten Import wird automatisch eine Vorlagenversion gespeichert — Version wiederherstellen macht ihn also rückgängig.
Es gibt keinen Scheduler und keine Synchronisation im Hintergrund. Der erneute Import passiert, wenn Sie ihn anstoßen.
Berechtigungen
Importieren, erneut importieren und einen Import löschen sind Site-Admin-Aktionen.
Jeder Dashboard-, Gadget- und Filterzugriff während eines Imports läuft als die Person, die ihn ausführt — ein Site-Admin kann kein Dashboard importieren, das Jira ihm nicht zeigt. Spätere Exporte lesen die Filter des Reports erneut als die jeweils exportierende Person, der Import erweitert also niemandes Zugriff auf Jira-Daten. Siehe Berechtigungen & Rollen.
Limits
| Limit | Wert |
|---|---|
| Analysierte Gadgets pro Import | 12 |
| Oberhalb dieser Grenze zur Auswahl angebotene Gadgets | 60 |
Ein Dashboard mit mehr als zwölf Gadgets wird nicht abgeschnitten. Sie werden gefragt, welche Gadgets übernommen werden sollen, und die übrigen erscheinen wie jeder andere Ausschluss namentlich im Vollständigkeitshinweis.
Ein importierter Report ist ein gewöhnlicher Report und erbt alle Report-Limits — Datenquellen, Komponenten, Vorgänge pro Quelle. Siehe Limit-Referenz.
Zur genutzten Jira-API
Exportelier liest Dashboards ausschließlich über Atlassians dokumentierte Jira-Cloud-Dashboard-REST-API. Es parst keine Jira-Webseiten, liest keine Gadget-Iframes, erstellt keine Screenshots und nutzt keine undokumentierten Endpunkte.
Eine dieser Operationen — Get gadgets, die die Gadgets eines Dashboards auflistet — ist von Atlassian als Experimental gekennzeichnet. Atlassian kann sie also ohne die Stabilitätszusagen ändern, die für den Rest der API gelten. Ändert sie sich so, dass Exportelier sie nicht wiedererkennt, schaltet sich der Dashboard-Import selbst ab und sagt das — statt etwas zu importieren, das es falsch gelesen hat. Ihre bestehenden Reports, Vorlagen und Exporte sind davon nicht betroffen.