The Scan exclusion function in Acquia Web Governance lets Admin users configure custom exclusions to website scans. The configuration helps to target particular elements and prevent the contents from being flagged as issues.

Add exclusions to accessibility, readability, and misspelling checks on a customer level and then apply them to specific domains.

This document provides instructions on how to configure a scan exclusion.

Video walkthrough on scan exclusion setup¶

This video provides a quick walkthrough of the steps outlined in this document.

Scan exclusion walkthrough

Navigation¶

1. Click Admin Settings (the gear icon) on the top menu bar.

   

   The system displays the Admin dashboard.

2. Click Add a Scan Exclusion in the Quick actions section.

Alternatively:

1. Click Configuration (the wrench icon) on the left menu bar.
2. Select Scan Exclusion from the expanded options.
3. Select the type of scan exclusion that you want to add:

• Accessibility
• Misspellings
• Readability

Accessibility scan exclusions¶

This section provides instructions on the fields that you need to complete to create an accessibility scan exclusion.

1. Title (required): Add a title that describes the exclusion.
2. Auto-apply to domains with CMS: Do one of the following:
   • Select None (default) if there is no CMS.
   • Scroll through the list and select the CMS that is used for your domain.
   • Notes

     • If a domain with the same selected CMS exists on the Web Governance account, the domain automatically inherits the exclusion.
     • If the CMS used for your domain is not present in the list, contact the Support team and ask them to investigate if it is possible to add it.
3. HTML Exclusion: Provide the following information to exclude elements based on their name in the web page source code:
   1. Type (required). Select from the available options:
      • Exact: This type identifies and filters out all instances where the complete and exact HTML snippet is displayed. For example, the snippet https://www. example.com/ is an exact match for https://www.example.com/.
      • The following HTML snippets are not exact matches:
        • https://www.example.com
        • http://www.example.com/
        • https://example.com/
        • https://example.com/?something=1
        • https://example.com/#something=1
      • Regex: This type identifies and filters out specific patterns of HTML through the use of regular expressions.
      • Contains: This type identifies and filters out all snippets that contain the HTML values entered. For example, the snippet example.com is a match for the following HTML snippets:
        • https://www.example.com/
        • https://www.example.com
        • http://www. example.com/
        • https://example.com/
        • https://example.com/?query=1
        • https://example.com/subpage
        • https://example.com/subpage/product_page
   2. Value (required). Enter or paste the source code snippet that you want to exclude.
      • For example: <h2 class: “form-title”>
   3. Checks
      • Begin typing the name of the check and select the Accessibility checks to exclude from the list. Select as many as needed.
4. Click Save.
5. Repeat as needed.
6. Add the updated script to the HTML code. For more information, visit How to add the script.

Misspelled words scan exclusions¶

This section provides instructions on how to exclude a segment of a webpage from the spellcheck.

1. Title: Add a title that describes the exclusion (required).
2. Auto-apply to domains with CMS: Select the CMS that is used for your domain. Select None (default) if there is no CMS.

3. Apply exclusion to domains: Begin to type the name of the domain to populate the list and select one or more domains to apply this exclusion on.
4. CSS Selector Exclusion (required): Click in the field and select an existing CSS selector pattern from the drop-down menu, or click + to add a new one. Add as many as you need. Subsequent scans identify elements that match the entered CSS selector patterns and they are omitted from the results.
5. Click Save.
6. Add the updated script to the HTML code. For more information, visit How to add the script.

Readability scan exclusions¶

This section provides instructions on how to exclude a webpage from the Readability feature.

1. Title (required): Add a title that describes the exclusion.
2. Auto-apply to domains with CMS: Select the CMS that is used for your domain. Select None (default) if there is no CMS.
3. Apply exclusion to domains: Begin typing the name of the domain and select one or more domains to apply this exclusion on.
4. CSS Selector Exclusion (required): Click in the field and select an existing CSS selector pattern from the drop-down menu, or click + to add a new one. Add as many as you need. Subsequent scans identify elements that match the entered CSS selector patterns and they are omitted from the results.
5. Click Save.
6. Add the updated script to the HTML code. For more information, visit How to add the script.

Editing a scan exclusion¶

This section provides instructions on how to edit an existing scan exclusion.

1. Click Admin Settings (the gear icon) on the top menu bar.

   

   The system displays the Admin dashboard.

2. Click Configuration (the wrench icon) on the left menu bar.

3. Select Scan Exclusion from the expanded options.

   The system displays the list of existing scan exclusions.

4. On the same row as the scan exclusion that you want to edit, click the kebab menu and select Edit.
5. Make the changes as needed.
6. Save the changes.

Deleting a scan exclusion¶

This section provides instructions on how to delete a scan exclusion.

1. Click Admin Settings (the gear icon) on the top menu bar. 

   

   The system displays the Admin dashboard.

2. Click Configuration (the wrench icon) on the left menu bar.

3. Select Scan Exclusion from the expanded options.

   The system displays the list of existing scan exclusions.

4. Click the kebab menu on the same row as the scan exclusion that you want to delete and select Delete.

   The system displays a confirmation dialog box.

5. Click Delete in the dialog box to confirm. The system removes the scan exclusion from the list and from any domain that it was used on.

Additional resources¶

For more information, visit:

• Locate HTML Snippets to use in a Scan Exclusion
• CSS selectors by Mozilla
• CSS selector syntax by jsoup