What a sample is and how samples are managed within an audit.
What a sample is
A sample is one thing evaluated in an audit. Most of the time that is a web page, but a sample can also be a component, a PDF document, a mobile screen, or anything else the auditor needs to treat as a unit. Each sample is evaluated against the audit's criteria.
Sample types
The type is chosen when the sample is created and it changes what the identifier means:
| Type | Identifier is |
|---|---|
| Web page | The full URL of the page |
| Component | A unique reference for the component, such as a CSS selector or component name |
| PDF document | The file name or document reference |
| Mobile view | The screen or view name in the app |
| Custom | Any unique identifier for another kind of target |
Sample fields
- Name (required) - a descriptive label identifying the sample
- Type (required) - one of the five above
- Identifier (required) - meaning depends on the type
- Description (optional) - context or special considerations for auditing it
Anything longer than a line belongs in a sample-level note rather than the description. See methodology / using notes.
Adding samples
- One at a time, with Add Sample on the audit's Samples tab. A new sample starts with every criterion set to "Not tested".
- By importing an existing RGAA or RAWeb audit from an XLS or ODS file.
- By importing a CheckFox JSON export, or duplicating an audit.
- Via the browser extension.
Names and identifiers are unique within an audit; adding a duplicate is refused.
Limits
Each plan limits the number of samples per audit. See plans and roles.
What you do with a sample
- Evaluate criteria on it (record findings).
- Add it to a journey.
- Run the scanner on it, if the workspace has the scanner. See integrations.
Removing samples
Removing a sample removes its findings. Confirmation is required.