The Siteimprove CMS plugin is an overlay box, that, after installation, appears in your CMS platform informing you about issues related to the site/page that you are working on.
The Siteimprove Adobe AEM plugin (Released May 2019) is the CMS Plugin used specifically with Adobe Experience Manager. The Siteimprove Adobe AEM plugin has the added advantage of Siteimprove’s Pre-publish check functionality which allows you to check for certain content issues before publishing.
The plugin works like a small version of the Siteimprove Intelligence Platform and will only show information about pages that are available to our crawler. If you have excluded pages based on a common URL element, no data will be shown regarding those pages.
This article outlines the features available via the plugin.
CMS Plugin tab
Once the CMS Plugin is configured, a tab appears within your CMS.
When this tab is expanded you are presented with information about the site in general and your plugin history. If you are on a content page, issues and data specific to the page are also presented.
This section lists 10 of the last pages that you have checked using the plugin and their issues
The Site Overview shows general information about your site:
- DCI Score
- Quality Assurance issues
- Accessibility issues
- SEO issues
- Policy matches
- Overall Analytics information and Readability score if available
Note: The Siteimprove CMS plugin only displays information to services that are included in your subscription.
Plugin Page details
The CMS Plugin page details are divided into 3 sections via a drop-down: Page Content Issues, Page Analytics, and SEO.
Page Content Issues
The Page Content Issues section shows data relating to the following:
- Broken links
- Readability levels
- Accessibility issues (A, AA, AAA conformance level)
- Policies marked as all sites and CMS Plug-in
The Analytics section shows data relating to the following:
- Page visits
- Page views
- Time spent on page
- Internal traffic (referring pages and next pages)
- Feedback rating and comments
SEO Page details
The SEO section gives details on the following:
- SEO Technical issues
- SEO Content issues
- SEO User Experience issues
- SEO Search snippet preview
- SEO Keywords related to this page
- SEO Competing content
This option is available when on a content page in your CMS system which gives you the possibility to re-check/re-crawl the page. When pages are re-checked, results will be returned immediately.
How to use Siteimprove’s Pre-publish check functionality in AEM
When you are creating content for the first time or updating existing content, you can use Siteimprove’s Pre-publish check functionality to check some certain issues on your content before publishing.
- Make sure you have installed the latest version of Siteimprove’s CMS plug-in.
- Log-in to your Siteimprove account via Siteimprove’s CMS plug-in.
Use Pre-publish check
- In edit mode for AEM, click “Toggle Siteimprove content check” button on the top menu bar.
- The left panel will display a copy of your website and the CMS plug-in will be expanded on the right.
- Click “See Results” when some results are available or wait until all the checks are done.
- You can then see the results for the pre-publish checks for your content under Quality Assurance, Policy and SEO tabs.
- You can analyze all the pre-publish check results by expanding the table to see the exact issues, number of occurrences, highlighting options in AEM and a short description of the issue.
- If the highlighting button is enabled, click the button to highlight the issue on AEM.
- In this example, we highlight a potential misspelling (Skitouring) from Quality Assurance module.
- You will see the highlighted area on the left panel where the copy of your website is displayed.
- If the issue cannot be highlighted because the element is hidden, you will see a notification bar on the top of your page.
- Navigate to Policy tab to see the matching content policies and navigate to SEO tab to see relevant Technical Issues, Content Issues, and User Experience Issues.
- Click “Close Results” to display the results for your original page.
- Navigate to “My History” and click “See results” to see results for the last Pre-publish check from your session.
Checks available in pre-publish functionality
- Potential Misspellings
- Language Detection
- Email Addresses
- Link Text
- Meta Tags
- Content policies that are marked as CMS Plug-in and enabled for all sites
- Technical Issues
- HTML validation errors
- Missing structured data markup
- Missing Open Graph tags
- Page-level nofollow tags
- Pages with noindex metatag
- Pages with frames or iFrames
- Content Issues
- Pages with low text-to-code ratio
- Empty meta descriptions
- Missing meta descriptions
- Pages with multiple meta descriptions
- Meta descriptions are too short
- Meta descriptions are too long
- Empty meta titles
- Pages with multiple meta titles
- Meta titles are too long
- Meta titles are too short
- Missing H1 tags
- Empty H1 tags
- Pages with multiple H1 headers
- Low content word count
- User Experience Issues
- Images missing alt attributes
When unpublishing or deleting an online page that is online Siteimprove have created a small tool to help the user get an overview of the impact of removing this page.
We gather all the information that we see relevant for this page and make that available to the user, this can be relevant if another department is using this page for a campaign or if external sites are linking to this specific page.
The check will only provide information from services that you subscribe to and if no information is found about a topic, it will be left out of the result set.
Use Unpublish check
In the AEM Sites overview, choose the page that you want to unpublish or delete and the Siteimprove unpublish icon will appear in the menu bar on the top of the view.
When the Unpublish button is clicked a pop-up window with information appears.
This window have 3 tabs with different information about the page. Quality Assurance (QA), SEO and Analytics.
The QA tab will show you information about internal referring pages and documents on this page.
The SEO tab will show you if this page is used as a target page, about backlinks and Keywords.
The Analytics tab will inform you about any usage of this page in regards to Key Metrics, Behaviour maps and Campaigns.
The Analytics tab will also inform about any external pages linking to this page and pageviews within the last 30 days.
Checks available in unpublish functionality
- Documents on page this page (List of documents)
- Documents only on this page (List of documents)
- Internal referring pages (List URL’s)
- Backlinks (List of backlinks)
- Is this page a target page (Y/N)
- Ranking keywords (List of keywords and position)
- External referring pages (List URL’s)
- Has behavior map (Y/N)
- Page views (Number of pageview within 30 days)
- Potential campaigns (List of Potential Campaigns this page might be part of)
- Potential key metrics (List of potential key metrics using this page)
Siteimprove Content Check - AEM Workflow Support
As well as being used in the AEM editor interface Siteimprove the pre-publish checks are also supported in the AEM workflow. Here, we supply a sample workflow model showing the possibilities for incorporating this into your publishing workflow.
You can establish your own workflow by either adjusting this sample workflow or using the workflow steps in your own workflow, as needed. Please refer to the standard Adobe documentation for workflow editing.
Graphical overview of the workflow model:
Description of the Workflow steps
- Run Siteimprove content check process step
This workflow step triggers the upload of the payload (i.e. the page the workflow was started with) to Siteimprove for running the pre-publish checks.
- Run Siteimprove content verification process step
This workflow step allows to configure for each of the metrics (see below) the operand (i.e. <, <=, ==, >, >=) and the value to compare to.
An example that configures a target value of 0 for both Misspellings and Potential Misspellings metrics:
- OR Split
The OR Split is configured with two branches, the left branch is executed in case all configured verification metrics match, the right branch will be executed if at least one of the checks fails.
There are two scripts provided that can be used in your own logic:
-> returns true if workflow metadata property hasErrors == false
-> returns true if workflow metadata property hasErrors == true
- Left branch
Activates the payload
- Right branch
Fix content errors step: The Fix content errors step assigns the workflow to the person that started the workflow via the OOTB Workflow Initiator Participant Chooser step.
Re-run content check step: The re-run content check step uses the OOTB Goto Step to go back to the first step. This would be invoked by the author after fixing the violations in order to re-check the content.
- Flow end
End of the workflow
If you have any questions please contact your Siteimprove Administrator or contact the Siteimprove Technical Support team with your request.