Instructions¶

This article provides instructions for authorized users on how to do a Quick Scan with the Acquia Optimize quick scan module in Drupal.
The quick scan can be run from the standard Drupal forms editing interface and from the experience builder interface.

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 Acquia Optimize 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 Acquia Optimize UI to view the full reports if you have an Acquia Optimize account.
   1. Click the link to the Acquia Optimize Account in the module UI in the editor.
   2. Click the link to the Acquia Optimize user documentation to view the user documentation.
6. Re-scan the page as needed.

From the Experience Builder interface¶

1. Open Experience Builder.
2. Navigate to Extensions - Acquia Optimize on the left panel to launch the experience builder dialog.

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 Acquia Optimize API for the scan.

4. When the module receives the results, you can view them summarized on the Experience Builder 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 Acquia Optimize customers can navigate to the Acquia Optimize UI
   1. Click the link to the Acquia Optimize Account in the module UI in the editor.
   2. Click the link to the Acquia Optimize user documentation to view the user documentation.

By default the Quick Scan functionality is already included, but if you are already an Acquia Optimize customer, you can do this step

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 Acquia Optimize 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 Acquia Optimize API due to a server error. Please try again later.

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

Clickable demo¶

Visit the Aquia Optimize - Drupal Moduleclickable demo for more information.

Additional resources¶

For advanced instructions, visit Optimize for Developers page about Drupal.