Siteimprove Integration

Overview

Cascade CMS's Siteimprove plugin allows users whose organizations have existing Siteimprove accounts to access the Siteimprove Intelligence Platform from within the CMS. It enables you and your team to identify and correct accessibility issues as soon as a page is published. This plugin also makes it easier for content contributors, managers, and editors to leverage Siteimprove Analytics data to create better content more efficiently.

The plugin overlays quality assurance, analytics, and accessibility data when viewing the relevant content in Cascade CMS.

Page data in the Siteimprove plugin

Enabling the Siteimprove Plugin

To enable the Siteimprove plugin for your instance:

  1. Click the system menu button (  ) > Administration > Preferences > Integrations & Plugins.
  2. Under Siteimprove Settings enable the Enable Siteimprove Plugin option.
  3. Optionally, enable Do not include "index" in Siteimprove URLs.
    • Select this option if the index pages for your site appear as https://www.example.com/about/ in Siteimprove as opposed to https://www.example.com/about/index.html.
  4. Click Submit.
  5. Navigate to any site and you'll see the Siteimprove badge on the right-hand side of the interface.
  6. Click Login to log in with your Siteimprove credentials.
Note - This plugin requires a secure HTTPS connection to connect and exchange information with the Siteimprove service. Please ensure SSL is configured for your instance before enabling it.
Note - Your first login will need to be by a Siteimprove account owner who can accept the plugin’s Terms and Conditions for the account. Afterwards, other users will be able to login with their credentials as well.

Viewing Siteimprove Data

Page Data

To view Siteimprove data for a page, navigate to the page within Cascade CMS and open the plugin by clicking on the Siteimprove badge. You can view data for index pages either by navigating to the index page itself or its parent folder.

If you're not seeing data for your page in the overlay, ensure that:

  • Your site been imported into your Siteimprove account.
  • The Site URL for your site in Cascade CMS is the same as the URL in your Siteimprove account. If not, set the Siteimprove URL in Site Settings.
  • Your page has been published.
  • Your page has been crawled by Siteimprove.

Publishing a page will trigger a recrawl of the page by Siteimprove. You can also use the Re-check page button in the plugin to issue a manual request for Siteimprove to recrawl it.

Publishing a folder will trigger a recrawl of all pages in the folder.

Site Data

To view site-level data for your site, select the Site Overview tab in the plugin. When viewing a folder that doesn't contain an index page, site-level data will be displayed by default.

Publishing a site's base folder, Destinations, or site itself will trigger a recrawl of the site by Siteimprove.

Configuring the Siteimprove URL

If the URL of your site in Siteimprove is different than the Site URL of your site in Cascade CMS, specify your Siteimprove URL under Manage Site > Site Settings > Siteimprove URL.

Deeplinking in Siteimprove

To make correcting issues in your content more efficient, Siteimprove offers CMS Deeplinking. Deeplinking creates links to your page assets in Cascade CMS from within reports in Siteimprove. To do this, the ID of your page asset needs to be included in the published page source.

You can include page IDs in your templates with a simple region and Velocity format:

  1. Create a new region within the <head> tags of your template(s). Example:

    <system-region name="ID"/>
  2. Create a Velocity format containing the following and attach it to the region in your template:

    <meta name="id" content="${currentPage.identifier.id}"/>
  3. Publish all pages that use the template(s) to ensure that your page ID <meta> tag gets included the pages on your web server.