Jira-integratie sjablonen

Sjablonen zijn vooraf ingestelde koppelingen van axe-issuevelden naar Jira-velden die helpen om gestandaardiseerde formaten voor Jira-tickets te creëren. Sjablonen kunnen voor elk project en elke combinatie van issuetype worden gemaakt en kunnen door iedereen in je organisatie worden gebruikt bij het verzenden van issues naar Jira.

Beheer van sjabloontoegang

Wie kan sjablonen maken

Iedereen met toegang tot het Jira-integratieproduct kan sjablonen maken.

Wie kan sjablonen bewerken of verwijderen

• Sjabloonauteurs: Gebruikers die het sjabloon hebben gemaakt, kunnen hun eigen sjablonen bewerken of verwijderen
• axe Account Portal-beheerders: Kunnen elk sjabloon in de organisatie bewerken of verwijderen

Sjabloonmachtigingen

• Sjablonen zijn organisatiebrede middelen
• Alle gebruikers met toegang tot Jira-integratie kunnen elk sjabloon gebruiken
• Alleen sjabloonauteurs en beheerders kunnen sjablonen wijzigen
• Sjablonen kunnen niet worden beperkt tot specifieke gebruikers of groepen

Een sjabloon maken

1. Navigeer naar de pagina "CONFIGURATIE" binnen het axe Account Portal (of navigeer direct naar https://axe.deque.com/configuration/integrations en sla stap 2 over)
2. Klik op de "Integratiemenu" link binnen de "Configuratie" navigatie
3. Klik op de "Jira-sjablonen configureren"-link
4. Klik op de "Sjabloon toevoegen"-knop
5. Vul de velden in bij de stappen "Sjablooninformatie", "Veldovereenkomst" en "Impactovereenkomst". Meer details over elke stap vind je in de volgende secties.
6. Controleer de informatie die is ingevuld in de stappen 1 tot en met 3
7. Klik op "Opslaan"

Om een sjabloon te gebruiken, raadpleeg de Issues naar Jira verzenden-sectie.

Sjablooninformatie toevoegen

De eerste stap bij het creëren van een sjabloon is het configureren van de basisinformatie die bepaalt waar en hoe issues in Jira worden aangemaakt.

1. Sjabloonnaam: Voer een beschrijvende naam in voor je sjabloon. Deze naam wordt weergegeven in de sjabloonlijst bij het verzenden van issues naar Jira. Voorbeeld: "A11Y Bug", "Mobile Accessibility", "WCAG 2.1 Overtredingen"
2. Project: Selecteer het Jira-project waar issues worden aangemaakt bij gebruik van dit sjabloon. De vervolgkeuzelijst toont alle projecten waarvoor je toestemming hebt om issues te creëren.
3. Issuetype: Kies het type issue dat in Jira wordt aangemaakt. De beschikbare opties zijn afhankelijk van de configuratie van je geselecteerde project. Veelvoorkomende types: Bug, Taak, Verhaal, Sub-taak
4. Axe-issuescreenshots als bijlagen inschakelen: Wanneer aangevinkt, worden screenshots die door axe-tools zijn vastgelegd automatisch bij het Jira-ticket gevoegd. Dit biedt visuele context voor ontwikkelaars die de issues oplossen.

Veldovereenkomst configureren

Op de veldovereenkomstpagina kan de gebruiker axe-velden aan Jira-velden koppelen om toegankelijkheidsgegevens automatisch over te dragen bij het aanmaken van tickets:

1. Selecteer in de Jira-veldvervolgkeuzelijst het Jira-veld dat je wilt koppelen
2. Kies in de axe-veldvervolgkeuzelijst het bijbehorende axe-gegevensveld
3. Klik op + Axe-veld toevoegen om extra velden te koppelen
4. Klik op de min (-) knop om een koppeling te verwijderen
5. Klik op de Volgende-knop om op te slaan

Belangrijk: Alle vereiste Jira-velden (bijv. Samenvatting) worden automatisch op deze pagina weergegeven. Als je ze niet aan axe-velden koppelt, worden gebruikers gevraagd om ze handmatig in te vullen bij het verzenden van issues.

Veel voorkomende axe-velden die beschikbaar zijn voor koppeling zijn:

1. Regel: de ID van de toegankelijkheidsregel die werd geschonden
2. Beschrijving: gedetailleerde beschrijving van het toegankelijkheidsprobleem
3. Hoe op te lossen: instructies om het probleem op te lossen
4. Hulp-URL: link naar de documentatie van de regel
5. Probleemsamenvatting: korte samenvatting van het probleem
6. Selector: CSS-selector voor het element
7. Elementbron: HTML-broncode van het element
8. Screenshot-URL van het probleem: de URL van de screenshot die bij het probleem hoort
9. Tags: array van stringtags van metadata voor het probleem (categorieën, wcag-controlepuntidentificaties, enz.)
10. Testnaam: naam van de opgeslagen test waarin het probleem werd gevonden
11. Gedeelde URL van het probleem: directe link naar het gedeelde probleem in het axe-product
12. Aangemaakt op: de datum waarop het probleem werd gedetecteerd
13. Test-URL van het probleem: URL van de geteste pagina
14. Gevonden door: gebruiker die de test heeft uitgevoerd waarin het probleem werd opgemerkt
15. Paginatitel: documenttitel van de geteste pagina
16. Axe-versie: de axe-core versie die voor de test is gebruikt

Jira Beschrijving veld

Het Jira beschrijvingsveld volgt een gestandaardiseerde structuur die niet kan worden aangepast of in kaart gebracht. Wanneer problemen naar Jira worden verzonden, bevatten ze automatisch een gestructureerde beschrijving met de volgende secties:

• Probleembeschrijving: beschrijving van het probleem
• Hoe op te lossen: stapsgewijze instructies voor herstel
• Probleemlocatie:
  • Selector: CSS-selector van element met probleem
  • Elementbron: HTML-broncode van element met probleem
• Pagina-URL: URL van de geteste pagina
• Aanvullende details:
  • Impact: ernstniveau van het probleem
  • Axe Issuelink: link naar issuereport in het axe Accountportaal (indien beschikbaar)
  • Regelhulp: link naar regeldocumentatie

Impact Mapping Configureren

Toegankelijkheidsproblemen in axe worden geclassificeerd op impactniveau, wat aangeeft hoe ernstig ze gebruikers beïnvloeden. Op de Impact Mapping-pagina kun je deze impactniveaus aan jouw Jira-prioriteitswaarden koppelen om een juiste prioritering van issues te garanderen.

Foutafhandeling

Validatie van Verplicht Veld

Als een verplicht veld leeg blijft in de template

Tijdens het verzenden van een issue zal het systeem een foutmelding tonen en moeten gebruikers een waarde invoeren voor het verplichte veld voordat het issue naar Jira kan worden verzonden. Een axe-issue kan niet naar Jira worden verzonden totdat alle verplichte velden waarden hebben.

Als een template een waarde naar een verplicht Jira-veld mappt maar de waarde niet in alle axe-producten bestaat

• Tijdens het maken van de template zal het systeem een waarschuwingsmelding geven dat het gemapte veld niet in alle axe-producten beschikbaar is, maar gebruikers kunnen doorgaan met het maken van de template ondanks de waarschuwing.
• Tijdens het verzenden van issues naar Jira, als een template mappings naar velden bevat die in een Deque-product ontbreken, zal er een waarschuwingsmelding verschijnen. Het systeem zal de velden markeren die handmatige invoer vereisen en gebruikers moeten handmatig waarden invoeren voor ontbrekende verplichte velden voordat het issue kan worden verzonden. Issues worden pas naar Jira verzonden zodra alle verplichte velden zijn ingevuld—ofwel door bestaande mappings of door handmatige invoer.

Sjablonen Bewerken en Verwijderen

Om een sjabloon te bewerken of te verwijderen activeer je het "Opties"-menu voor de gegeven sjabloon en krijg je 2 opties:

• Sjabloon bewerken
• Sjabloon verwijderen