Troubleshoot the Siteimprove Sitecore plugin

Summary

Troubleshoot common issues with the Siteimprove Sitecore plugin, including plugin UI loading problems, missing check data, incorrect URL analysis, mapping issues, access limitations, and server-side debugging.

Overview

Use this article when the Siteimprove Sitecore plugin is not loading, is returning no data, is analyzing the wrong URL, or behaves inconsistently across Sitecore sites or environments. It also provides server-side debugging steps for cases involving custom Sitecore LinkManager implementations.

Environment / Applicability

• Siteimprove Sitecore plugin
• Sitecore Content Editor
• Sitecore mapping configuration
• Siteimprove crawled sites
• Prepublish checks
• Server-side Sitecore logging

Before you begin

Review access, deployment, mapping, crawl, and configuration requirements before troubleshooting plugin behavior.

Troubleshooting

Common Issues

Plugin UI does not load:
Verify package/config deployment.
Verify user role membership and authentication.

Checks return no data:
Verify site is crawled in Siteimprove.
Verify mapped domains and roots match live URL structure.

Wrong URL analyzed:
Re-check Domain, Start item, Language, and Virtual Folder values.

Inconsistent behavior across sites:
Validate each mapping item separately.
Compare config differences per environment.

When It Will Not Work

Site is not crawled in Siteimprove.
Mapping does not represent real public URL structure.
API user/key is missing for Prepublish checks.
User lacks access to plugin role or required Sitecore permissions.

Steps

Server-Side Debugging

If you have custom Sitecore’s LinkManager implemented and experience server-side errors or unexpected behavior in the Siteimprove module, follow the steps below to diagnose the issue.

Step 1: Enable DEBUG-Level Logging in Sitecore

Activate a configuration patch file that overrides the root logger priority to DEBUG.
File: App_Config/Include/zzz.Debug.Logging.config.example(included to package version 2.2)

Remove or rename this patch file after debugging. Leaving DEBUG logging enabled in production significantly increases log volume and disk usage.

Step 2: Trigger the Module

Open Content Editor and navigate to any content item with a Siteimprove mapping assigned. This triggers the Siteimprove plugin to generate its iframe and execute server-side logic.

Step 3: Inspect the Sitecore Log File

Check the latest Sitecore log file for Siteimprove-related entries: $(dataFolder)/logs/log.{date}.{time}.txt (default path)