Ga naar hoofdinhoud

Importeren vanuit een Jira-dashboard

Exportelier kan een Jira-dashboard lezen en daar een rapport van bouwen. Je kiest een dashboard, Exportelier vertelt gadget voor gadget wat het heeft begrepen, jij vult aan wat Jira niet heeft meegegeven, en je krijgt een gewoon bewerkbaar rapport.

Twee dingen zijn goed om vooraf te weten, want ze bepalen al het andere op deze pagina.

Dit is een semantische import, geen plaatje

Exportelier importeert de configuratie van het dashboard — welk filter, welk veld, welk grafiektype — en bouwt die opnieuw op met eigen componenten. Het resultaat is geen schermafbeelding, geen pixelgetrouwe kopie en geen ingesloten Jira-pagina. Kolombreedtes, gadgetranden en exacte witruimte worden niet gereproduceerd, omdat de publieke API van Jira ze niet prijsgeeft.

Handmatig herstellen is normaal, geen gebrek

Atlassian garandeert niet dat de instellingen van een ingebouwde gadget via een publieke API leesbaar zijn. Is een instelling niet leesbaar, dan vraagt Exportelier je om die te kiezen. Het raadt nooit welk filter of welk veld je bedoelde.

Wat geïmporteerd kan worden

Jira-gadgetWordtOpmerkingen
Filter ResultsIssue-tabelBehoudt de gekozen kolommen en hun volgorde
Pie ChartCategoriegrafiek (cirkel)Gebruikt het statistiektype van de gadget
Work Item StatisticsCategoriegrafiek (staaf)Gebruikt het statistiektype van de gadget
Two Dimensional Filter StatisticsMatrixGebruikt beide asvelden
Created vs. Resolved ChartTijdreeksgrafiekNeemt de periode en terugkijkduur van de gadget over — zie de grenzen hieronder
Sprint BurndownVereist historische sprintgegevens die Exportelier nog niet levert
Al het overigeWordt bij naam genoemd en uitgesloten, nooit stilzwijgend weggelaten

Elke gadget op het dashboard krijgt precies één status:

  • Gereed — herkend, en alles wat nodig was, was leesbaar.
  • Herstel nodig — herkend, maar je moet een ontbrekende instelling opgeven.
  • Later beschikbaar — herkend, maar de bijbehorende Exportelier-component bestaat nog niet. Sprint Burndown valt hieronder.
  • Niet ondersteund — een gadget van derden of een onbekende gadget. Die wordt bij naam genoemd, niet verborgen.
  • Fout — Jira liet Exportelier de gadget niet lezen, of wat het las was tegenstrijdig. Dit blokkeert de import tot je het in Jira oplost.

Herkenning gebeurt op de technische identiteit van de gadget, nooit op de titel. Een gadget hernoemen in Jira, of Jira in een andere taal gebruiken, verandert niets aan wat Exportelier ervan maakt — en een eigen gadget «Pie Chart» noemen maakt er geen Pie Chart van.

Wat een grafiek aangemaakt/opgelost laat zien

Een geïmporteerde grafiek aangemaakt/opgelost telt de aanmaak- en oplosdatums van de issues die het opgeslagen filter vandaag oplevert. Hij reconstrueert niet welke issues het filter in het verleden opleverde.

Dat is van belang wanneer de inhoud van het filter is veranderd. Is een issue uit het project gehaald dat het filter afdekt, dan verdwijnt het uit alle perioden van de grafiek — ook uit die van vóór de verplaatsing. De gadget van Jira doet om dezelfde reden hetzelfde, maar het is goed om te weten voordat je twee exports van maanden na elkaar vergelijkt.

Er zijn nog drie mogelijke verschillen, en elk daarvan wordt in de volledigheidsmelding van het rapport genoemd wanneer het van toepassing is:

  • Rapportageperiode. Dagelijks, wekelijks en maandelijks worden exact overgenomen. Per uur wordt dagelijks, per kwartaal en per jaar worden maandelijks — de totalen blijven gelijk, alleen de breedte van elke periode verschilt.
  • De trendlijn van onopgeloste issues. Jira kan er een derde lijn overheen tekenen met de openstaande issues in de tijd. De grafiek van Exportelier toont alleen de reeksen aangemaakt en opgelost.
  • Terugkijkduur. Een periode langer dan 366 dagen wordt ingekort tot 366 dagen.

Al het overige — het filter, de cumulatieve modus, de cijfers zelf — komt ongewijzigd mee, en je kunt al deze instellingen achteraf in de designer aanpassen.

De import

  1. Open Rapporten en kies Importeren vanuit Jira-dashboard.
  2. Kies een dashboard. Hier verschijnen alleen dashboards die Jira je al toont — sitebeheerder zijn in Exportelier verbreedt die lijst niet.
  3. Lees de analyse. Elke gadget staat er met zijn status.
  4. Herstel wat hersteld moet worden. Het opgeslagen filter en de velden kies je via de gebruikelijke keuzelijsten; een veld voor ruwe JQL is er bewust niet.
  5. Controleer de volledigheid. Alles wat wegvalt, staat er bij naam, en je moet de uitsluitingen expliciet bevestigen voordat het rapport kan worden aangemaakt.
  6. Maak het rapport aan. Het opent in de gewone designer, volledig bewerkbaar.

Alles wat nog Herstel nodig of Fout is, blokkeert het aanmaken. Exportelier weigert liever dan een rapport te maken dat stilzwijgend een half dashboard weglaat.

De volledigheidsmelding

Elk geïmporteerd rapport begint met een volledigheidsmelding — een echte component in het document, geen hint in de interface. Die noemt het brondashboard, wanneer het is geïmporteerd, hoeveel gadgets zijn meegenomen en elke gadget die dat niet is, bij titel.

Het is een informatiemelding als alles is geïmporteerd en een waarschuwing zodra er iets is weggelaten. Hij verschijnt in PDF, Word en Markdown.

Zolang het rapport aan zijn import gekoppeld blijft, beheert Exportelier de melding: de rest van de opmaak kun je vrij verplaatsen, maar de melding kun je niet verwijderen of herschrijven. Wordt hij toch verwijderd of gewijzigd, dan laat het rapport zich niet exporteren — een document dat beweert een dashboard weer te geven terwijl het er stilzwijgend een deel van weglaat, is erger dan geen document.

Wil je een rapport zonder de melding, dupliceer het dan. Een duplicaat is een gewoon rapport zonder import erachter en zonder beheerde melding.

Het dashboard bijhouden

De import is een momentopname van de configuratie van het dashboard. De gegevens blijven live: een rapport leest zijn opgeslagen filters bij het exporteren opnieuw, dus de cijfers zijn ook maanden later actueel.

Wat niet vanzelf meebeweegt, zijn opmaak en configuratie. Voegt iemand in Jira een gadget toe, of richt hij er een op een ander filter, dan werkt jouw rapport precies zoals daarvoor totdat jij iets anders bepaalt.

Open het rapport en gebruik Controleren op wijzigingen. Exportelier leest het dashboard opnieuw en deelt elke gadget in als toegevoegd, verwijderd, verplaatst, configuratie gewijzigd of ongewijzigd. Opnieuw importeren past dat vervolgens toe:

  • ongewijzigde en verplaatste gadgets houden wat ze hebben;
  • wat jij zelf aan het rapport hebt toegevoegd, blijft ongemoeid;
  • gewijzigde en toegevoegde gadgets krijgen nieuwe inhoud;
  • een gadget waarvan de nieuwe configuratie niet automatisch op te lossen is, stopt de herimport en gaat naar herstel, in plaats van jouw werk met een gok te overschrijven;
  • een gadget dat als "later beschikbaar" was uitgesloten en dat een nieuwere Exportelier-versie wel kan importeren, verschijnt als gewijzigd, en de herimport zet het onderaan het rapport. Bestaande rapporten krijgen nooit een component alleen omdat er een versie is uitgebracht — je moet erom vragen.

Vóór elke herimport wordt automatisch een sjabloonversie opgeslagen, dus Versie herstellen maakt hem ongedaan.

Er is geen planner en geen synchronisatie op de achtergrond. Herimporteren gebeurt wanneer jij erom vraagt.

Rechten

Importeren, opnieuw importeren en een import verwijderen zijn sitebeheerder-acties.

Elke dashboard-, gadget- en filterlezing tijdens een import draait als de persoon die hem uitvoert: een sitebeheerder kan geen dashboard importeren dat Jira hem niet toont. Latere exports lezen de filters van het rapport opnieuw als degene die exporteert, dus de import verbreedt niemands toegang tot Jira-gegevens. Zie Rechten en rollen.

Limieten

LimietWaarde
Geanalyseerde gadgets per import12
Boven die grens ter selectie aangeboden gadgets60

Een dashboard met meer dan twaalf gadgets wordt niet afgekapt. Je wordt gevraagd welke gadgets je wilt overnemen, en de rest wordt net als elke andere uitsluiting bij naam genoemd in de volledigheidsmelding.

Een geïmporteerd rapport is een gewoon rapport en erft alle rapportlimieten — databronnen, componenten, issues per bron. Zie de limietenreferentie.

Over de gebruikte Jira-API

Exportelier leest dashboards uitsluitend via de door Atlassian gedocumenteerde Jira Cloud dashboard-REST-API. Het ontleedt geen Jira-webpagina's, leest geen gadget-iframes, maakt geen schermafbeeldingen en gebruikt geen ongedocumenteerde endpoints.

Eén van die bewerkingen — Get gadgets, die de gadgets van een dashboard opsomt — is door Atlassian als Experimental aangemerkt. Atlassian mag hem dus wijzigen zonder de stabiliteitsgaranties die voor de rest van de API gelden. Verandert hij zo dat Exportelier hem niet herkent, dan schakelt de dashboard-import zichzelf uit en zegt dat, in plaats van iets te importeren dat het verkeerd heeft gelezen. Je bestaande rapporten, sjablonen en exports blijven ongemoeid.

Gerelateerde pagina's