Instructions¶

This article provides instructions for authorized users on how to do the Acquia Web Governance Quick Scan in Drupal.

Run the Quick Scan from the standard Drupal forms edit interface and the Drupal Canvas interface.

Running the Quick Scan from the Drupal nodes editing interface¶

1. Click Start Quick Scan.

   The system displays a progress bar to show the scan render progress. On completion of this process, the results are loaded and the rendered page is sent to the API for the scan.

2. When the module receives the results, you can view them summarized on the Drupal sidebar in the following categories:
   • Accessibility: Issues are summarized by guideline level (WCAG 2.1 A, WCAG 2.1 AA)
     For more information, visit Accessibility feature.
   • Readability: Issues are  shown as a level, mapped from the resulting score.
     For more information about readability scores, visit Quality Assurance Readability.
   • SEO: For more information, visit Search engine optimization.
   • Data Privacy Topics: For more information, visit Data privacy.
3. Click View Issues to view the list of issues and number of occurrences on the page of each issue.
4. Click a specific issue for more information about it. For example, snippets of the HTML where the issue was detected.
5. Navigate to the Web Governance UI to view the full reports if you have an Web Governance account.
   1. Click the link to the Web Governance account in the module UI in the editor.
   2. Click the link to the Web Governance user documentation to view the user documentation.
6. Re-scan the page as needed.

Running the Quick Scan from the Drupal Canvas interface¶

1. Open Drupal Canvas.
2. Navigate to Extensions > Web Governance on the left panel.

3. Click Start Quick Scan.

   The system displays a progress bar to show the scan render progress. On completion of this process, the results are loaded and the rendered page is sent to the Web Governance API for the scan.

4. When the module receives the results, you can view them summarized on the Drupal Canvas sidebar in the following categories:
   • Accessibility: Issues are summarized by guideline level (WCAG 2.1 A, WCAG 2.1 AA)
     For more information, visit Accessibility feature.
   • Readability: Issues are  shown as a level, mapped from the resulting score.
     For more information about readability scores, visit Quality Assurance Readability.
   • SEO: For more information, visit Search engine optimization.
   • Data Privacy Topics: For more information, visit Data privacy.
5. Click View Issues to view the list of issues and number of occurrences on the page of each issue.
6. Existing Web Governance customers can navigate to the Web Governance UI.
   1. Click the link to the Web Governance account in the module UI in the editor.
   2. Click the link to the Web Governance user documentation to view the user documentation.

By default the Quick Scan functionality is already included. However, if you are already an Web Governance customer, you can re-scan the page as needed.

Errors¶

The following errors can occur with a scan. This list provides the error name and a short description about what the error means:

• Error: There was an error gathering the content. Please try again.

  Description: The module is unable to build the payload.

• Error: The scan request has timed out. Please try again later.
• Description: The API does not respond or times out.

• Error: Access to the Web Governance was denied. Contact your administrator for help.

  Description: The API provided does not have permission for the Quick Scan feature (422).

• Error: Could not connect to the Web Governance API due to a server error. Please try again later.

  Description: The API has failed (500-5xx).

Clickable demo¶

Visit the clickable demo for the Web Governance Drupal module for more information.

Additional resources¶

For advanced instructions, visit the Web Governance Developers page for Drupal.