Getting Started with axe Reports

Link to Getting Started with axe Reports copied to clipboard

Welcome to the axe Reports Getting started topic.

Here you learn about the first steps with axe Reports. If you need more detailed explanations of all features, please visit the respective sections in our user guide.

Step 1: Configuring the Dashboard

As an axe Reports Administrator, when you log in for the first time the system may prompt you about your dashboard not being configured. The same message is displayed when your project users login to axe Reports before you’ve configured the dashboard, they can see this message to contact their axe Reports administrator.

Organization not configured message

Note for axe Monitor® Users: For the data to be successfully imported, it is required that the project in axe Monitor® is set up to send scan information to axe Reports (Include project data in axe Reports). This setting is available under Settings → Project → General screen on axe Monitor.

Step 2: Configuring the Project for axe Monitor®, Test Cases for axe Auditor, Or Scripts for axe DevTools

You can either use axe Monitor®, Test Cases for axe Auditor, or axe DevTools HTML components to configure your projects, test cases, or scripts with axe Reports.

Configuring your project is how you create a data structure in your report that makes sense to your organization. You build the hierarchy of your report starting with the axe Monitor project and add it to dimensions that are like levels in your reporting structure. To know more about this, read the topic below.

You can import accessibility issues data generated using axe Devtools HTML APIs/CLI. The data is grouped by individual ‘Script’. A script can be thought of as a group of related pages that are scanned using one or more spec files (for axe DevTools HTML CLI), or using automated tests (for axe DevTools HTML API). To know more about this, read the topic below.

To work with test cases, you can edit a data structure in your report that makes sense to your organization. You build the hierarchy of your report starting with the axe Auditor test case and add it to dimensions that are like levels in your reporting structure.

Step 3: Using the Charts in axe Reports

Once you have configured your projects, test cases or scripts in axe Reports, you can use the three different types of charts that capture your data.

Score Trend

This chart represents a time-series view for accessibility score for all properties included in the level of hierarchy selected.

Accessibility Health

This chart captures the total number of accessibility issues captured at the selected level of hierarchy by issue severity.

Issues By Period

This chart captures how your issues are trending with the total number of accessibility issues rolling up to the period you've selected. The default period is Issues by Month, and the chart represents each month in your selected start and end dates if data exists for that period.

axe DevTools - Using the Usage Reports

Once you have configured your script, you can also use the two different types of Usage Reports. Usage Reports comprise usage data for various axe products in axe Reports. Usage data help managers look at usage trends and understand how axe products are being utilized in their organizations to be able to take appropriate steps to improve accessibility of their end product.