These steps explain the process in the new navigation. If you are not subscribed to the Web Governance Early Access program, these steps may differ from your view. Contact support to join the Early Access program. All customers will automatically receive the update after the initial rollout.
Introduction
This document provides information on how to do a PDF accessibility scan and request a PDF remediation with Acquia Web Governance.
PDF accessibility scan
This section provides instructions on how to do a PDF accessibility scan.
Navigate to the Domain overview and select your domain.
On the domain menu bar, click Accessibility (icon of a human figure with outstretched arms). The system opens the Accessibilitysummary page.
Select PDFs from the menu on the left.
Internal PDFs
Select this tab to view PDF files that are uploaded on your site.
Sort the chart with the following options:
Pending
Queued
Failed
Approved
Use the radio boxes to select one or several PDFs.
Select Scan for accessibility to do a scan on the selected PDF files. PDF files that are waiting for the scan to complete are marked as Queued.
If the scan is successful and no accessibility errors are found, the PDF is marked as Approved.
If the scan is successful and some accessibility errors are found, the PDF is marked as Failed.
Select the PDF to view the results.
Repair the errors or use the PDF remediation option. For instructions, visit Remediation Quote.
Upload the new PDF documents and start a new scan.
The scan results are imported directly into your account and are available through the dashboard.
External PDFs
Select this tab to view PDF files that are external. The scan cannot read external PDFs, these need to be reviewed manually.
Select the tab above the list to sort for:
Pending
Approved
Select Action and Mark as approved after the file is updated.
To scan the document with Web Governance, you must make the PDF internal within your settings.
Scan results
The scan results are imported directly into your account and are available through the dashboard.
Select the PDF from the list to view the scan results.
Repair the issues or use the PDF remediation option. For more information, visit PDF remediation quote.
Upload the corrected PDF documents.
Start a new scan.
Here is an example of a scan report:
Columns are:
Name: The name of the error. In this example, the first row is "Alternative Representat.." (truncated).
Result_type: The type of error. In this example, the first row is "error".
Page_number: The page that the error is on. In this example, the first row is "1".
Element_tree_path: How to locate this error directly in the tree path for the report. In this example, the first row is "Annotations->11".
Reason: The reason for the error. In this example, the first row is "Link Annotation doesn't..." (truncated).
Clarity_comments: Any comments from the CommonLook/Clarity team. In this example, the first row is empty.
Check the scan results
To find more details about the PDF from the scan results, use Web Governance Quality Assurance.
Instructions
Navigate to your domain.
Select Quality Assurance (the checkbox icon), on the domain dashboard toolbar.
Select Content with QA Errors from the menu on the left side of the page.
Select the PDF Documents tab above the chart.
Select a document in the list for more information about the scan results.
If any PDF files require remediation, you can repair them yourself or make a request for remediation from within the platform. The remediated documents and accessibility reports are delivered to your email when they are ready. To include the PDF scanning tool, contact Support to upgrade your account. This section provides instructions on how to request a remediation quote. This option is only available from within the platform for customers located in the U.S.A.
Do an accessibility scan as per the previous section and locate the failing PDF files.
Click to select Remediation Quote on the same row as a failing PDF.
This submits anorder for remediation of issues that require attention in the PDF. This service is provided by a third party. A dialog box opens with the following text:
"Document remediation for compliance to WCAG 2.1 AA, Section 508, HHS or PDF/UA accessibility standards. Document remediation requires manual verification and can range in cost. When you submit PDF documents for remediation, we will review the document and give you a firm, fixed price for the remediation. Upon completion of the work, we will also provide a compliance report. We will let you know if there is any Alternative Text (Alt-Text) required for images that are not self-descriptive or any related additional information needed to remediate the document."
Click OK to confirm.
The remediated PDFs are sent to your email when they are finished.
Remove the existing PDFs with errors fom the website and upload the remediated PDFs to replace them.
Change the status of the PDFs manually to Mark as reviewed.
Note
EU customers must contact Commonlook directly for PDF remediation quotes at their own discretion due to regulatory requirements. The PDF Remediation option continues to be available for customers in other geographical regions.
For more information on the PDF accessibility scan service, visit:
PDF scans are done through a Remediation Quote. Order a list of issues that require attention in the PDF. This service is provided by a third-party provider, CommonLook Clarity:
EU customers must contact Commonlook directly for PDF remediation quotes at their own discretion due to regulatory requirements. The PDF Remediation option continues to be available for customers in other geographical regions.
The Content Links count in the Inventory module shows the number of links that point to PDF files. This is not the same as PDF files that are internal and present on the site. For example, the inventory may state a higher number of PDF links than the Accessibility module PDF file count.
Bulk remediation quotes and PDF accessibility checks
For accounts that are upgraded to include the PDF scanning tool, it is possible to request a bulk remediation quote that includes all PDFs.
Select Accessibility from the domain dashboard.
Select PDFs from the menu on the left.
Select the Internal PDFs tab.
Choose Select all (number) PDFs or use the radio boxes to select several PDFs.
Select Scan for accessibility to scan all selected PDFs.
EU customers must contact Commonlook directly for PDF remediation quotes at their own discretion due to regulatory requirements. The PDF Remediation option continues to be available for customers in other geographical regions.
Advanced instructions
Some web security measures block the CommonLook PDF crawler that Web Governance uses. If you encounter issues with the PDF scan, allowlist the Web Governance IP addresses and user agents.
These steps explain the process in the new navigation. If you are not subscribed to the Web Governance Early Access program, these steps may differ from your view. Contact support to join the Early Access program. All customers will automatically receive the update after the initial rollout.
Introduction
This document provides information on how to do a PDF accessibility scan and request a PDF remediation with Acquia Web Governance.
PDF accessibility scan
This section provides instructions on how to do a PDF accessibility scan.
Navigate to the Domain overview and select your domain.
On the domain menu bar, click Accessibility (icon of a human figure with outstretched arms). The system opens the Accessibilitysummary page.
Select PDFs from the menu on the left.
Internal PDFs
Select this tab to view PDF files that are uploaded on your site.
Sort the chart with the following options:
Pending
Queued
Failed
Approved
Use the radio boxes to select one or several PDFs.
Select Scan for accessibility to do a scan on the selected PDF files. PDF files that are waiting for the scan to complete are marked as Queued.
If the scan is successful and no accessibility errors are found, the PDF is marked as Approved.
If the scan is successful and some accessibility errors are found, the PDF is marked as Failed.
Select the PDF to view the results.
Repair the errors or use the PDF remediation option. For instructions, visit Remediation Quote.
Upload the new PDF documents and start a new scan.
The scan results are imported directly into your account and are available through the dashboard.
External PDFs
Select this tab to view PDF files that are external. The scan cannot read external PDFs, these need to be reviewed manually.
Select the tab above the list to sort for:
Pending
Approved
Select Action and Mark as approved after the file is updated.
To scan the document with Web Governance, you must make the PDF internal within your settings.
Scan results
The scan results are imported directly into your account and are available through the dashboard.
Select the PDF from the list to view the scan results.
Repair the issues or use the PDF remediation option. For more information, visit PDF remediation quote.
Upload the corrected PDF documents.
Start a new scan.
Here is an example of a scan report:
Columns are:
Name: The name of the error. In this example, the first row is "Alternative Representat.." (truncated).
Result_type: The type of error. In this example, the first row is "error".
Page_number: The page that the error is on. In this example, the first row is "1".
Element_tree_path: How to locate this error directly in the tree path for the report. In this example, the first row is "Annotations->11".
Reason: The reason for the error. In this example, the first row is "Link Annotation doesn't..." (truncated).
Clarity_comments: Any comments from the CommonLook/Clarity team. In this example, the first row is empty.
Check the scan results
To find more details about the PDF from the scan results, use Web Governance Quality Assurance.
Instructions
Navigate to your domain.
Select Quality Assurance (the checkbox icon), on the domain dashboard toolbar.
Select Content with QA Errors from the menu on the left side of the page.
Select the PDF Documents tab above the chart.
Select a document in the list for more information about the scan results.
If any PDF files require remediation, you can repair them yourself or make a request for remediation from within the platform. The remediated documents and accessibility reports are delivered to your email when they are ready. To include the PDF scanning tool, contact Support to upgrade your account. This section provides instructions on how to request a remediation quote. This option is only available from within the platform for customers located in the U.S.A.
Do an accessibility scan as per the previous section and locate the failing PDF files.
Click to select Remediation Quote on the same row as a failing PDF.
This submits anorder for remediation of issues that require attention in the PDF. This service is provided by a third party. A dialog box opens with the following text:
"Document remediation for compliance to WCAG 2.1 AA, Section 508, HHS or PDF/UA accessibility standards. Document remediation requires manual verification and can range in cost. When you submit PDF documents for remediation, we will review the document and give you a firm, fixed price for the remediation. Upon completion of the work, we will also provide a compliance report. We will let you know if there is any Alternative Text (Alt-Text) required for images that are not self-descriptive or any related additional information needed to remediate the document."
Click OK to confirm.
The remediated PDFs are sent to your email when they are finished.
Remove the existing PDFs with errors fom the website and upload the remediated PDFs to replace them.
Change the status of the PDFs manually to Mark as reviewed.
Note
EU customers must contact Commonlook directly for PDF remediation quotes at their own discretion due to regulatory requirements. The PDF Remediation option continues to be available for customers in other geographical regions.
For more information on the PDF accessibility scan service, visit:
PDF scans are done through a Remediation Quote. Order a list of issues that require attention in the PDF. This service is provided by a third-party provider, CommonLook Clarity:
EU customers must contact Commonlook directly for PDF remediation quotes at their own discretion due to regulatory requirements. The PDF Remediation option continues to be available for customers in other geographical regions.
The Content Links count in the Inventory module shows the number of links that point to PDF files. This is not the same as PDF files that are internal and present on the site. For example, the inventory may state a higher number of PDF links than the Accessibility module PDF file count.
Bulk remediation quotes and PDF accessibility checks
For accounts that are upgraded to include the PDF scanning tool, it is possible to request a bulk remediation quote that includes all PDFs.
Select Accessibility from the domain dashboard.
Select PDFs from the menu on the left.
Select the Internal PDFs tab.
Choose Select all (number) PDFs or use the radio boxes to select several PDFs.
Select Scan for accessibility to scan all selected PDFs.
EU customers must contact Commonlook directly for PDF remediation quotes at their own discretion due to regulatory requirements. The PDF Remediation option continues to be available for customers in other geographical regions.
Advanced instructions
Some web security measures block the CommonLook PDF crawler that Web Governance uses. If you encounter issues with the PDF scan, allowlist the Web Governance IP addresses and user agents.
Web Governance