Link Check

Overview

Link Check allows users to test all links on a page, both internal and external, and provides information and status codes for these links. Link Check can be run from both Page Check and Final Check.

There are several ways the Link Check can be performed. First, users can access this tool from the Page Check modal. Click the Links button to run the check.

Links Button in the Page Check Modal

Additionally, Link Check may run during Final Check as part of the Publish Process. Depending on how Final Check has been configured, Link Check may run automatically; otherwise, it can be run manually by pressing the Links button in the Final Check modal.

Link Check in the Final Check Modal

Performing a Link Check

There are several ways to perform a Link Check:

  1. Navigate to the Pages list view by selecting Content > Pages from the global navigation bar.
  2. Hover on the target page's row and select Page Check from the Review menu to display the Page Check modal.

    Additionally, selecting Publish from the Publish menu to display the Final Check modal will also provide the ability to perform a Link Check.
  3. Click the Links button to run the check. If desired, click Show Results once the check has completed to view results of the check.

Users can also perform a Link Check from the Page Actions toolbar:

  1. Navigate to the Pages list view by selecting Content > Pages from the global navigation bar and select the page to be edited.

    Additionally, selecting the page from the File Navigation sidebar also displays a view with the Page Actions toolbar included.
  2. Click the Page Check button in the Page Actions toolbar to display the Page Check modal.

    Additionally, clicking the Publish button displays the Final Check modal.
  3. Click the Links button to run the check. If desired, click Show Results once the check has completed to view results of the check.

Link Check Results

When users click the Link Check button, it will attempt to validate all on-page links for the selected page, including mailto links. Both staging and production links are spidered. 

There are three different indicators that can display after a Link Check has been performed:

Link Check OK (No Errors)

If there are no warnings or errors during the Link Check report, the button is shaded green and the message "OK" displays. This indicates that links are either valid or skipped (by design). 

Link Check Warning Indicator

The Link Check button is shaded gold and the message "Warning" with a numerical value indicating the number of potential errors. The system flags a warning for a link when the result of a request for a resource is indeterminate; that is, it did not receive either a positive 202 that the link was OK or a 404 indicating that the file was missing. Other status codes are also possible.

Link Check Errors Present

If the result of a request for a resource there are any errors confirmed by the Link Check report; that is, the result of the request for a file is a client or server error; such as a 404, not found, the Link Check button is shaded red and the number of errors is listed underneath the button.

Show Results

After running Link Check, click Show Results below the button to display the Link Check Results modal. This modal provides a list of the links checked, their status on staging and production, and the applicable status codes. The modal can also be opened in a new window by clicking Open in New Window. The results modal includes the following:

  • Link URL: Lists the URL or defined href that was requested. 
  • Staging: Indicates the status of the file on the staging server. Hovering over the status icon will reveal a tooltip about the status.
  • Production: Indicates the status of the file on the production server. Hovering over the status icon will reveal a tooltip about the status.
  • Status Code: When applicable, provides the response to the request

Link Check Results Modal

Icon Column Meaning
Yellow Warning Notification Icon Staging Link is not on staging. Indicates that the link is broken on the page in staging.
Blue Warning Icon Notification Production Cannot check link, all 100 statuses. Link check is unable to verify if it is a valid link or not. Often occurs if the link is a mailto
Green Checkmark Icon Staging, Production Link is Valid (202), all other 200 statuses. The link points to a page that correctly renders.
Yellow Warning Notification Icon Production Moved Permanently (301), Found (302), all other 300 statuses. The file has been moved, or any other miscellaneous issue.
Red Warning Icon Notification Production

Not Found (404), all other 400 or 500 statues. The link points to a nonexistent destination (the link has been misspelled, the page has moved, etc.)