Site Check

Overview

Authority Level: This report is available to level 9 and 10 administrators.

Site Check allows OU Campus administrators to check all links across the site, both internal and external. The resulting report provides a list of all broken links and all warnings, which can then be used to make global changes or individual changes as necessary. This tool works in conjunction with the individual link checking feature of Page Check.

The Site Check can be found at Reports > Site Check.

Site Check in the Reports Menu

 

Site Check will check links on staging that are to the production server, but it won't scan those pages on the production server and check their links.

Running a Site Check

To run a site check:

  1. Navigate to Reports > Site Check. in the Scope options, use the Select All checkbox or pick and choose the directories and files to run the check on.

    Site Check Scope View
  2. Scroll past the Scope panel and set the Link Check options. Alternatively, click Link Check in the secondary navigation bar.

    Link Check in Secondary Navigation Bar
    There are three options in the Link Check panel:
    • Follow Redirects: Checking this option will direct the system to follow all redirects to the final resulting page for the most accurate reporting.
    • With Includes: Checking this option directs the system to check the links within any include files. If an include file of a page being checked can not be reached page check reports an error.
    • Timeout: Select how long the system should attempt to check each link before reporting that the page could not be found. The default is 30 seconds.

      Link Check Panel
  3. Click Run.

This may take several minutes to complete. It is possible to continue with other work while this is running, or cancel the Site Check that is being run. If additional administrators attempt to run the check during this process, they will see the same "Site Check in progress" status indicator. Once the Site Check is finished, a notification will appear at the bottom of the screen.

Reviewing Site Check Results

After the check has been completed, the results are shown in three reports. These are visible to all administrators. The available reports are:

  • All Broken Links
  • Broken Links by Page
  • Invalid Pages

All Broken Links

All Broken Links Report

This report lists all broken links. This report can be exported as a CSV file using the Export CSV button.

This list view includes:

  • The number of pages with broken links listed in the view
  • Link Column: Shows full URL for the broken link.
  • Path: Shows the page that has the broken link. Click the link to preview the page.
  • Staging: Indicates the result of the link check on the staging server.
  • Production: Indicates the result of the link check on the production server.
  • Status Code: Shows the HTTP response status code, if applicable.

There will not always be an icon in both the Staging and Production columns depending on the link, where it resides, and the result.

Broken Links by Page

The Broken Links by Page report shows all pages on which there is one or more broken links or warnings. Once the links have been fixed, the report can be rerun by hovering over the row and selecting Rerun

Broken Links by Page Report

This report includes:

  • Path: Shows the root relative path and be clicked to preview the page
  • OK: Number of links that were tested as okay or valid
  • Broken: The number of broken links on the page
  • Warning: The number of links with warnings
  • Unchecked: The number of links that were not checked
  • Last Checked/Options: The date that the links were last checked and when hovering over the row includes the options to View Results, Preview, and Rerun 

Click Results while hovering over a row to view the File Results modal. This modal shows the file results and includes the following:

  • The file name of the content that was checked
  • The ability to load the modal in a new window
  • Link URL: Shows the root relative path; when clicked, administrators will be taken to the page preview
  • Staging: Indicates the result of the link check on the staging server
  • Production: Indicates the result of the link check on the production server
  • Status Code: Shows the HTTP response status code, if applicable

Page Results Modal

Click Close to dismiss the modal.

Rerunning a Site Check

From the Broken Links by Page view, all pages can be selected or individual pages can be selected and then the site check rerun.

  1. From the Site Check menu, click Broken Links by Page.
  2. Use the checkboxes to select all pages or individual pages.
  3. Click Rerun on the header of the list view if multiple files are selected, or hover over the list item and click Rerun.

    Rerun Broken Links by Page

Invalid Pages

The Invalid Pages report will provide a list of pages that could not be checked and the error code indicating why that page could not be checked. These pages have a Preview option which will take the user to the page. However, if the PCF cannot be rendered, the issue causing the error must be fixed before the page can be checked.

Invalid Pages Report

About the Validator

The W3C Compliance Validator is a service that OmniUpdate offers to they clients which helps check the validity of Web documents.

Most Web documents are written using markup languages, such as HTML or XHTML. These languages are defined by technical specifications, which usually include a machine-readable formal grammar (and vocabulary). The act of checking a document against these constraints is called validation, and this is what the Markup Validator does.

Validating web documents is an important step which can dramatically help improving and ensuring their quality. Validation is, however, neither a full quality check, nor is it strictly equivalent to checking for conformance to the specification.

This Validator can process documents written in most markup languages. Supported document types include the HTML (through HTML 4.01) and XHTML (1.0 and 1.1) family, MathML, SMIL and SVG (1.0 and 1.1, including the mobile profiles). The Markup Validator can also validate Web documents written with an SGML or XML DTD, provided they use a proper document type declaration.

This Validator is also an HTML validating system conforming to International Standard ISO/IEC 15445-HyperText Markup Language, and International Standard ISO 8879-Standard Generalized Markup Language (SGML), which basically means that in addition to W3C recommendations, it can validate according to these ISO standards.

Icon Guide

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