Introduction

Drupal admin users can add the Web Governance Quick Scan module to their Drupal account. With this module, content authors in Drupal can start the Quick Scan and see the results directly in the Drupal edit screen. This article provides instructions for admin users on how to set up and initiate a scan with this feature.

Install in Drupal

This section provides instructions on how to install and enable the Quick Scan module in Drupal.

• Log in to Drupal.
• Click Extend on the top menu bar.
• Use the filter to search for Web Governance.
• Tick the radio box to select Web Governance.
• Click Install.
• Confirm the installation, click Content on the top menu bar.
• Click Edit on the same row as a list item to view the details.
• Locate Web Governance in the panel on the right side of the page.
• Click the arrow to expand the details.
• Click API key. This step is required to ensure that you are a registered user. You will get the API key and URL from Web Governance.

How to get the API key and URL from Web Governance 

• Open Web Governance.
• Click Admin Settings (gear icon) on the top menu bar.
• Click API Users in the left menu. Add a new API user if needed.
• Click Action on the same row as an existing API user in the list.
• Select See API Token.
• Copy the token. 
  Do not close the token window.

Paste the API token and API URL into Drupal

• Return to the Drupal page and paste the token into the space provided.
• Return to Web Governance and close the token window.
• Copy the corresponding API URL from the list.
• Return to the Drupal page and paste the API URL into the space provided.

• Select the appropriate Accessibility Guideline from the drop-down menu.

  For the full article on WCAG compliance, visit WCAG compliance.

• Click Save Configuration.
• Click Content on the Drupal menu bar to return to the list of pages.
• Click Edit on the same row as the page with the Web Governance module.
• Locate Web Governance in the panel on the right side of the page.
• Click the arrow to expand the details. The Start Quick Scan button is now available.

Web Governance configuration

This section provides instructions for Drupal admin users on how to configure user permissions.

• Open the Nodes editing interface in Drupal. This can be done by Drupal admin users.

• The module shows the Start Quick Scan button in the editing interface. It also shows the following message:

  Web Governance Module is not configured. Please, add account details in the module settings (link to settings) or register for a free scan for a demo.

• Approve the Web Governance scanning permission to continue.
• Click People on the top menu bar
• Select Permissions. Only admin users can do this action.
• Use the filter to find Web Governance.

• Assign required permissions to user roles.

  • Web Governance administration
    • Select the user roles to grant admin permissions to the Web Governance module.
  • Web Governance scanning
    • Select the user roles to grant permissions to do a scan.

  Users with the Author role must also be assigned to the Web Governance permission to view the Web Governance module through the Editor. Content Author users can scan a single web page in Drupal before it is published. 

How to start the Web Governance Quick Scan in Drupal

For instructions, visit How to do the Quick Scan in Drupal

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 API 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 more information:

Quick scan in the Drupal module

Additional resources

For advanced instructions, visit the Developers page about Drupal.