Documentation Center

Installing the Siteimprove extension

To set up the Siteimprove extension in Tridion Sites, upload it through the Add-ons Service.

Before you begin

To install the Tridion extension for Siteimprove, you'll need the following:

  • Tridion Sites 9.1 or later
  • Siteimprove account

Procedure

  1. Upload the Siteimprove extension ZIP package to the Add-ons Service.
  2. Go to the following URL to obtain an unique CMS token from Siteimprove for the current Tridion Sites environment:
    https://my2.siteimprove.com/auth/token?cms=SDLTridionSites 

    You will receive a JSON response with the token, such as:

    {"token":"a0925bd6ec524d8d8896f1adeec4e2a3"}

    Copy the token for use in the next step.

  3. From the following location, open the extension's configuration file for editing:
    <TRIDION_HOME>\web\WebUI\WebRoot\Editors\Siteimprove\Configuration\SiteimproveEditor.config

    Where <TRIDION_HOME> is the location where Tridion Sites is installed.

  4. In the <clientconfiguration> section, define the following:
    • cmsToken – The Siteimprove token obtained token in step 2.
    • baseUrl – The base URL of your production site that will be crawled by Siteimprove rather than the staging site. If the staging site is available for the crawler, leave this parameter empty. This URL replaces the staging base URL when requesting reports from Siteimprove.

    Example:

    <customconfiguration>  
    <clientconfiguration>
    <cmsToken>a0925bd6ec524d8d8896f1adeec4e2a3</cmsToken>
    <baseUrl>https://www.company.com</baseUrl>
    <scripUrl>https://cdn.siteimprove.net/cms/overlay.js</scripUrl>
    </clientconfiguration>
    </customconfiguration>
  5. Open Internet Information Services (IIS) Manager, and recycle the SDL Tridion Sites application pool.
  6. Refresh the browser cache.
  7. Verify that the extension is available by opening Tridion Sites Experience Manager on your staging site. In the ribbon toolbar you should see a new button for Siteimprove. To the right, the Siteimprove widget should appear.