SiteAttention Sitecore Header

SEO plugin for Sitecore

Our integrated Sitecore SEO plugin - provides real-time guidance when creating post, blogs or articles.

Try it free for 30 days


Downloads

SiteAttention Installation guide:
Module for Sitecore 8.1:
Module for Sitecore 8.2:
Module for Sitecore 9.0:

Documentation


The following will guide you through the process of using SiteAttention SEO plugin (version 0.9.2) for Sitecore version 8.1 and 8.2 and 9.0


Prerequisites

The SiteAttention module for Sitecore is currently tested on the following Sitecore versions:

Sitecore 8.1

Sitecore 8.2

Sitecore 9.0

The module officially supports all MVC based solutions that utilize the standard SPEAK ribbon in the Experience Editor. It has not been tested on WebForms based Sitecore solutions or on solutions that uses the deprecated SheerUI ribbon in the Experience Editor. The module might work on these solutions but reported bugs will not be investigated.


Installation instructions

The SiteAttention module for Sitecore is installed using the Sitecore package installation wizard from the Sitecore Client. The module should only be installed on Content Management instances in a scaled Sitecore environment. For Sitecore 8 solutions please ensure that the configuration file is disabled on other instance roles using Sitecore configuration patching. For the Sitecore 9 version, the configuration elements have require role “standalone or content management” attributes.

See config file found in /App_Config/Include/Foundation/SiteAttention

Upload and install the SiteAttention module package using the Sitecore Package Installation wizard.

Tick both checkboxes to restart the Sitecore instance when the package has been installed succesfully.

Ensure that you have obtained a package that is built for the relevant Sitecore version before installing the package. It is highly encouraged to verify the modules compatibility by installing the package in a non-production environment first.


Configuration

The module can be configured on either global (solution-wide) or site-specific scope using configuration items. It is recommended always to configure the module per site context rather than using the system module scope.


Creating a site-specific settings item:

Create a new item using the SiteAttention Settings branch within the site root. Preferably within a dedicated Settings folder for the specific site context.

Sitecore Insert from template image

It is important that the item reside beneath the site root item to ensure this item is selected as the contextual settings for the site.


The Settings item contain a Single-Line text field for the SiteAttention License key. Make sure to insert a valid license key in this field. Leave the instance name and ID fields blank as these are populated by the module.

If the public host name differs from the Content Management hostname use the field Public Host Name to fill in the actual public hostname.

SiteAttention Settings image

The SiteAttention module evaluates content that editors type in using the Experience Editor interface. All rendering types that editors can edit via the Experience Editor and contain content that is specific for a page SEO should be configured using a Dynamic Rendering Info item.

Right click on the Dynamic Renderings folder and insert a Dynamic Rendering info for each rendering type that is relevant.

Dynamic Rendering image

Select the Rendering item. SEO type is in this version of the module always content and the Tags field is not used.

Only create Dynamic Rendering Info items for the innermost renderings that does not contain placeholders to prevent evaluating the same content multiple times. Do not create Dynamic Rendering Info items for renderings that do not contain page specific content (f. ex. primary menu, service menus, footer, logo, etc.)


The SiteAttention module must be able to pick up the Page title and Meta description as these are rendered to the published page.

Two Static Rendering items exist in the settings folder called Static Renderings beneath the SiteAttention settings item.

  1. Pick the rendering item that generates the Page title / meta description markup in the Rendering item field. This rendering is rendered server-side in standard mode and use xpath to find the page title and meta description.
  2. Type in a help message for the editor that explains how to edit the page title / meta description of the page in this solution.
Static Rendering image

Publish the Settings item including subitems and related items when done.


System Settings

If it is not possible to create a Settings item within each site context or if it for some reason does not apply to the solution you can configure the module using the shared settings item found under /sitecore/system/modules/SiteAttention

System Settings image

This item is used when a contextual settings item does not exist within the site context.


Editor Roles

For an editor to be able to use the SiteAttention module their user profile must be a member of the role sitecore/SiteAttention.

The role can be added to user profiles directly or you can choose to add the role to a specific editor role and use the roles-in-roles feature of Sitecore.

Adding the role to editors is done using the Sitecore User Manager or Role Manager applications.

User Manager:

User Manager image

Role Manager:

Role Manager image

The role is automatically created if it does not already exist by a processor patched into the initialize pipeline. This may require a recycling of the app pool on the CM instance to run. This initialize processor can safely be removed when the role exists in the database or if roles in the solution is maintained elsewhere using a serialization provider such as Unicorn or TDS.

Users marked as administrator will automatically always have access to the SiteAttention module in the Experience Editor.

Download SiteAttention Installation Instructions