Skip to content

Previously the "Comply custom reporter" from Devservices, now useful for any customer. Allows customers to login via the CLI and fetch detailed data from their Monitor projects.

License

Notifications You must be signed in to change notification settings

dequelabs/monitor-utility

Repository files navigation

Monitor Utility

Automatically fetches data from monthly Monitor scans and generates an Excel file deliverable. Each row on the sheet is a Site representing a Project within an Organization. For each Project, a URL is given to the shared report, as well as a total count of pages, total issues found across the pages, and percentage of raw data (a calculated score). The issue counts are broken down into counts per grouping. The issue grouping categories are ARIA, Color, Forms, Keyboard, Language, Media, Name Role Value, Parsing, PDF, Semantics, Sensory and Visual Cues, Structure, Tables, Text Alternatives, and Time.

Instructions

You will need access to the Monitor instance you want to use, including projects and scans within the organization. First step is to install the dependent packages by executing 'npm install' from the root of the project code. To run the code, from the root run npm run report. Enter the Monitor URL, making sure it does not end with a slash. Login with your email and password when prompted.

Code Design

The script begins in index.js, which prompts the user for all input information and verifies URL and date format. After prompting, it calls reporter.js. It checks that a username and password were provided, and begins fetching results by first getting the project IDs in getProjectIds.js from the /worldspace/organizationprojects endpoint of the Monitor 6.7 API. Once the projects are identified, it continues in the reporter and uses the IDs to gather details (/worldspace/projects/details/${project.id}) and summary reports (/worldspace/project/summaryReport/${project.id}) for each project. After all requests are completed, it compiles the data in transformer.js. It then continues in the reporter to write the file and calculate completion time.

Modifying the output

To modify what in output in the csv update the results that are pushed inside the transformer.js file.

About

Previously the "Comply custom reporter" from Devservices, now useful for any customer. Allows customers to login via the CLI and fetch detailed data from their Monitor projects.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published