Introduction¶

Drupal admin users can add the Acquia Optimize module to their Drupal account. With this module, content authors in Drupal can start the Quick Scan operation 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 Acquia Optimize module in Drupal.

1. Log in to Drupal.
2. Click Extend on the top menu bar.
3. Use the filter to search for Optimize.
4. Tick the radio box to select Acquia Optimize.
5. Click Install.
6. Confirm the installation, click Content on the top menu bar.
7. Click Edit on the same row as a list item to view the details.
8. Locate Acquia Optimize in the panel on the right side of the page.
9. Click the arrow to expand the details.
10. Click API key. This step is required to ensure that you are a registered user. You will get the API key and URL from Acquia Optimize.
11. Open Acquia Optimize.
12. Click Admin Settings (gear icon) on the top menu bar.
13. Click API Users in the left menu. Add a new API user if needed.
14. Click Action on the same row as an existing API user in the list.
15. Select See API Token.
16. Copy the token.
17. Return to the Drupal page and paste the token into the space provided.
18. Return to Optimize and close the token window.
19. Copy the corresponding API URL from the list.
20. Return to the Drupal page and paste the API URL into the space provided.

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

    For the full article on WCAG compliance, visit the user guide article:

    WCAG compliance.

22. Click Save Configuration.
23. Click Content on the Drupal menu bar to return to the list of pages.
24. Click Edit on the same row as the page with the Acquia Optimize Module.
25. Locate Acquia Optimize in the panel on the right side of the page.

26. Click the arrow to expand the details.

    The Start Quick Scan button is now available.

27. 

Acquia Optimize configuration¶

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

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

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

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

3. Approve the Acquia Optimize scanning permission to continue.
4. Click People on the top menu bar
5. Select Permissions. Only admin users can do this action.
6. Use the filter to find Optimize.

7. Assign required permissions to user roles.

   • Acquia Optimize Administration
     • Select the user roles to grant admin permissions to the Optimize module.
   • Acquia Optimize Scanning
     • Select the user roles to grant permissions to do a scan.

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

Do a Quick Scan¶

This section provides instructions for authorized users on how to do a Quick Scan with the Drupal Optimize module.

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.

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).