1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109This page is intended for **Project Leads and workspace members** responsible for setting up a new audit, including establishing clear naming conventions, scheduling automated scan frequencies (Daily, Weekly, or Monthly), and managing the specific URLs or PDFs that require monitoring.
## Overview of the audit builder
Use the audit builder to set up recurring audits for your workspace. Once you configure these audits, all workspace members can access them. To access the audit builder, from the main audits page, select "Add Audit." Selecting this option brings you to the "Audit Builder" page.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Audit%20Dashboard.png" alt="Audits dashboard with Search field, Filter View: My Audits dropdown, and buttons Quick Scan and Add Audit, plus a message stating no accessibility audits have been created yet." width="500"/><br>
## Step 1: Name your audit
When naming your audit, use clear, descriptive names that identify the scan's purpose or target, and include relevant details such as the website title or the associated department name. Acronyms can be helpful if the entire team understands what they stand for. It's also beneficial to follow a consistent naming convention to ensure easy identification and organization, and indicate if the scan includes PDFs, Websites, or both.<br>
**For example:** “UIC - School of Public Health - Web” or “UIC - College of Dentistry - PDFs” or “Athletics - Facilities - All”. Avoid including complete URLs or dates in the title, as the system automatically logs creation dates and URLs.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Audit%20Builder%20Name.png" alt="General Info configuration panel displaying Audit Name (required) input field and Scan Frequency dropdown selector." width="400"/>
## Step 2: Scan frequency/ Scheduling audits
You can scan manually (default setting), Daily, Weekly, or Monthly.
If your organization has no compliance or accessibility reporting requirements, we recommend setting them up monthly and running additional manual scans as your team updates an experience. Select the frequency from the dropdown you would like the audit to run.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Audit%20Builder%20Frequency.png" alt="General Info section with Audit Name (required) text field and Scan Frequency dropdown set to Manually." width="400"/><br>
```tip
💡Tip: If the organization has a compliance requirement, you must perform scans in accordance with those rules.
```
## Step 3: Email notifications
You can configure email notifications to keep yourself or your team informed about audit results.
Set up notifications while creating a new audit or by editing an existing one. You can choose from the following frequency options:
- Daily
- Weekly
- Monthly
With email notifications enabled, you’ll automatically receive updates—so there’s no need to manually check the dashboard to stay informed.
## Step 4: Add URL(s) to a scan
Equalify uses a URL-based approach - you provide the specific pages and documents you want scanned. This URL-based approach gives you complete control over what's included in each audit. It ensures consistent, reproducible results every scan. You can add URLs to your audit in four ways: WordPress Integration, Site Crawl, manually, or via bulk upload.
```important
⚠️Important: Equalify can only scan publicly available content. It cannot scan pages behind login or authentication. When you add an authenticated URL to your scan request, Equalify scans the authentication or login screen rather than the content beyond it.
```
### WordPress Integration
If your site runs on WordPress, the WordPress Integration tab is the easiest way to keep your audit in sync with your published content. It connects Equalify to a secure CSV feed generated by a WordPress plugin, so Equalify automatically discovers your pages, posts, and optionally PDFs.
**To connect your WordPress site:**
1. Install and activate the [Equalify WordPress Integration plugin](https://github.com/EqualifyEverything/equalify-wp-integration) on your WordPress site.
2. In your WordPress admin, go to **Settings > Equalify Integration**.
3. Copy the **CSV Feed URL** shown at the top of that page.
4. In the Equalify audit builder, select the **WordPress Integration** tab and paste the CSV Feed URL into the "CSV Feed URL" field.
5. Equalify validates the feed automatically. When the feed is found, a "CSV Found!" confirmation appears and your URLs are loaded into the audit.<br>
You can control which URLs are included or excluded from the plugin's Settings page in WordPress at any time.
### Site Crawl
The Site Crawl tab lets Equalify automatically discover pages on any website by reading its sitemap. This is useful when you don't manage the site in WordPress or prefer not to install a plugin.
**To crawl a site:**
1. Select the **Crawl Site** tab in the audit builder.
2. Enter the website's URL in the "Website URL" field (e.g., `example.com`).
3. Select **Crawl Site**. Equalify reads the site's `sitemap.xml` and returns all discovered URLs.
4. Once the crawl completes, a success message displays the number of URLs found and the discovery method used.
5. Review the discovered URLs in the table. You can deselect any pages you don't want included in the audit before saving.
```important
⚠️Important: Site Crawl is a one-time snapshot. Unlike WordPress Integration, Equalify does not stay in sync with your site — new pages added or removed after the crawl will not be reflected in the audit automatically. To pick up changes, you will need to re-crawl and update your audit manually.
```
```tip
💡Tip: If the site has no sitemap, Equalify falls back to adding just the root URL you entered. For best results, ensure the site publishes a sitemap.xml.
```
```tip
💡Tip: Large sites with thousands of pages will produce large audits. If a site has 10,000 or more URLs, consider limiting the audit scope by deselecting pages you don't need to scan.
```
### Manual entry
1. Enter a URL into the “URL” text box (e.g., https://it.uic.edu/accessibility/), then select “Add URL”.
1. Add URLs one at a time.
1. Once you add in the URL, Equalify will attempt to identify the type (HTML or PDF). You can adjust this as needed.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Add%20URLs%20Manual.png" alt="Add URLs to Scan with Import By dropdown set to URL, a URL text input with placeholder example.com, and an Add URL button." width="500"/><br>
### Bulk Upload (CSV)
To scan multiple documents or websites at once, use the CSV upload feature.
1. Begin by downloading the “Template CSV”. The CSV has two columns:
- **URL:** The link to the document or page.
- **Type:** Either PDF or HTML.
2. Complete the CSV
- Ensure that every URL starts with “https://”
```tip
💡Tip: When creating and uploading CSV files, it's best to avoid using special characters such as commas, quotes, and line breaks within your data fields, as they can cause parsing errors.
```
```tip
💡Tip: You can get a list of all pages on your site from your Content Management System (CMS), your sitemap.xml file, or a tool like Google Analytics, and then import them into Equalify via CSV.
```
3. Upload the completed CSV.
- Upload as many CSVs as you need; Equalify automatically skips duplicate items.
- If the type column is left blank, the system will automatically categorize the items.
- Upon successful upload, a banner appears confirming the upload worked.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Duplicate%20Upload.png" alt="CSV upload panel showing message 7 unchanged duplicate(s) skipped under CSV upload instructions and Download Template CSV and Add URL button." width="500"/><br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Successful%20Upload.png" alt="Confirmation notification banner stating Successfully processed CSV: 2 URL(s) added." width="500"/>
### Removing URLs from a scan
Remove URLs at any time—before or after an audit runs—by selecting the URLs and clicking "Remove 1+ URLs".
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Removing%20URLs.png" alt="URL management table listing multiple URLs with Type dropdowns (HTML or PDF) and selectable checkboxes for removal. One is selected and a Remove 1 URL(s) button below the list." width="500"/><br>
If an audit has already run, select "View or edit Audit URLs" from the dashboard.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/b800acaa513a3938d1d90578a6af223b39231480/user/User%20Guide%20Images/Sec%202_Removing%20URLs%20from%20Dashboard.png" alt="URL list table noting 2 URLs included with a View or Edit Audit URLs dropdown." width="500"/>
## Step 5 (Optional) Saving your audit for later
**If you are ready to run your audit, proceed to [“🔗 Running an Audit.”](https://github.com/EqualifyEverything/equalify-docs/blob/ccb65da8002cca64a598cc2bbeae164a04fce17c/user/Sec.%202.%20Configuring%20and%20Running%20Audits/2.4%3A%20Running%20an%20audit.md)**<br>
Once you add a URL, you can save your work and come back later by selecting "Save Audit" at the bottom of the page.
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/be72ad91bb91864306428980a098660aec2d446e/user/User%20Guide%20Images/Sec%202_Save%20and%20Run%20Audit%20options.png" alt="Audit builder showing Save Audit and Save & Run Audit buttons alongside pagination and URLs per page controls." width="500"/><br>
It will populate as an audit, and to make further changes to it, you must go to that audit's page. On an audit’s page, if no scans have been run yet, the chart notifies you that the Audit is “Not Yet Scanned”.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/be72ad91bb91864306428980a098660aec2d446e/user/User%20Guide%20Images/Sec%202_Saved%20audit%20draft.png" alt="Audit summary card draft displaying the message Not yet Scanned. This audit hasn’t been scanned yet. Add URLs below and run your first scan to discover accessibility blockers. " width="500"/>