AEM CMS Plugin Troubleshooting
Summary
Troubleshoot Siteimprove AEM CMS plugin installation issues, missing overlays or Prepublish controls, and page-data messages by checking the plugin version, dispatcher files, permissions, cloud configuration, crawling, and request URLs as applicable. Use debugging tooling and HAR files for further investigation, and contact Siteimprove Customer Support if the issue remains unresolved.
There are resources and steps below for troubleshooting. If they do not resolve the issue, contact Siteimprove Customer Support.
Installation issues
Make sure that you are installing the correct and latest plugin version for your AEM instance and following the package installation steps for that environment type.
Flush Installation Files When Using the Dispatcher
- No minification: page.css and page.js under /libs/cq/gui/components/authoring/editors/clientlibs/sites/
- Minification: page.min.css and page.min.js under the same path.
Issues with the Siteimprove overlay rendering in /sites.html
- Ensure deployments do not overwrite /apps/granite/ui/content/globalhead/siteimprove.
- Ensure the AEM user is a member of siteimprove-users.
- Ensure the selected page or a parent has a Siteimprove cloud configuration attached.
Plugin Overlay Does Not Render or Prepublish Check Is Missing
- The overlay will only render if the selected page or any of its parents has a Siteimprove cloud configuration attached. Ensure that the page you are looking at, or a parent of it, is configured under the "Plugin Active Paths" tab under the Plugin Cloud Service Configuration and/or that the correct Plugin Cloud Service Configuration is applied under Page Properties > Cloud Services > Cloud Services Configurations for the page or parent of the page.
- If you are using the dispatcher module on your authoring instance, please ensure that you follow the installation instructions for flushing the dispatcher under the Post-Installation Tasks and Configuration section.
- Ensure that your deployments do not overwrite the following customizations added by the plugin mentioned under the “AEM CMS Plugin Post-Installation Tasks and Configuration” article.
Plugin Paths (for plugins before version 3.0.13):
- /apps/granite/ui/content/globalhead/siteimprove (this is what loads the plugin on Touch UI pages)
- /apps/wcm/core/content/editor/jcr:content/content/items/content/header/items/headerbar/items/toggleContentCheck
- /apps/wcm/core/content/editor/jcr:content/content/items/content/header/items/headerbar/items/siteimprovePlugin
- /apps/wcm/core/content/editor/jcr:content/content/items/content/content/items/siteimprovecontentcheckresult
- /apps/wcm/core/content/sites/jcr:content/actions/selection/unpublishCheck
Plugin Paths (for plugins version 3.0.13 and after):
- /apps/siteimprove/plugin
- /apps/granite/ui/content/globalhead/siteimprove (this is what loads the plugin on Touch UI pages)
- /apps/wcm/core/content/sites/jcr:content/actions/selection/open-ue-siteimprove
- /conf/global/settings/siteimprove
Seeing “Page not found, No Results yet, or Missing access to page”
- Ensure the site is being crawled in the Siteimprove platform. Use a non-local development environment for testing.
- If the page is not published or crawled, this is expected. Use Prepublish if available, or publish and crawl the page.
- If the page is crawled, compare the plugin request URL with the crawled URL and adjust plugin or crawler configuration as appropriate.
- If the page is difficult to discover, use Single Page Check, a sitemap, or internal URLs as appropriate.
Debugging tooling in the plugin package
Debugging tooling is available in plugin versions 3.0.11 and above. See AEM CMS Plugin Debugging Tooling.
HAR files and Plugin Request URLs
Browser network requests for live page data must match the URLs crawled in the Siteimprove Platform. HAR files can help Support and Development troubleshoot configuration issues.
Review How do I create a HAR file? and CMS Plugins: How-to locate CMS plugin request URLs.
Did you find it helpful? Yes No
Send feedback