- ----- Episerver v. 11 -----
- 1. Installation
- 2. Configuration Admin
- 3. New Customer Registration
- 4. Existing Customer Registration
- 5. Instances
- 5a. Switching Instance
- 5b. Renaming Instance
- 5c. Creating a New Instance
- 6. Account Settings
- 7. Advanced Mapping
- 8. SiteAttention Toolbar
- 9. Page View
- 9a. Page Not Mapped View
- 10. Editing/ View Blocks or Trash
- 11. License Expired View
- 12. Quota Exceeded View
- 13. Download Instructions for Epi 11
- ----- Episerver v. 10 or older -----
- 1. Installation
- 2. Signup & Subscription
- 3. Registration
- 4. Activating your Account
- 5. Configuring SiteAttention
- 6. Setting up custom settings for a page type
- 7. Download Instructions for Epi 10 or older
SEO Plugin for Episerver
The following documents and videos will guide you through the process of using SiteAttention Episerver SEO plugin.
These will be updated on a regular basis and in accordance with new releases.
Episerver v. 11
To learn more about installation and mapping of SiteAttention for Episerver v. 11, watch the video below.
From Visual Studio add the SiteAttention 5.0.1 from the Episerver Nuget Feed. You can see the versions here: https://nuget.episerver.com/package/?id=SiteAttentionModule
If there are any custom mappings already configured - (custom page configuration) they will automatically be transferred in the update.
2. Configuration Admin
Go to CMS → ADMIN → SiteAttention.
You can now continue to the next step - Registration.
If you already have your license key, skip point 3, and go directly to point 4. Existing Customer Registration.
3. New Customer Registration
Type in your First name and email or the first name and email of the SiteAttention responsible person from your company and press Get Started.
This will provide you with a FREE 30 days trial (no strings attached) where you can use SiteAttention on up to 50 Pages.
An Instance for your Episerver environment will automatically be created. You can easily rename the instance.
This is described later, in the Instances section.
4. Existing Customer Registration
Type in your existing SiteAttention License key and press Auto-fill from License Key.
You will receive a new key.
Your existing instances show in the dropdown list under Instance Name.
Now you can switch between your instances by selecting your instance from the dropdown list and press save (the license key will be automatically updated to fit your selected instance).
All Instances are connected under the same License. So the quota will be based on the license quota shown on the left side.
To switch to another instance, select the instance you want to switch to and press Save Settings. You will see the License Key change when switching instance. The name TRIAL on instance is when instance is created without a name.
To rename an instance select the instance you want to rename and then press Save Settings (see Switching Instance section). In the Instance name field type in the new name of the instance and press Rename.
Creating a New Instance
If you want to create a new instance, simply type in Name in the Instance Name field and press New.
6. Account Settings
On the Account Settings Page, you can type in a property to let SiteAttention automatically pull in keywords from that property and use them as keywords. You can select to pull 1, 2 or 3 keywords from the list.
7. Advanced Mapping
On this page you can instruct SiteAttention to AutoMap all pages in the system. SiteAttention will iterate through page types and try to find the instance with most content and then estimate the mapping for that page , including Blocks and Inline properties.
Click Automap All.
You will see a loading symbol while the system is mapping.
When it is done you will have an automapping summary displayed on the right side.
NOTE: Make sure you go through summary and check if the mapping is done correctly!
You can go in and edit the mapping configurations by selecting either a page type or a Block type/inline property in the selected drop downs.
When a page or a Block is selected you will see the mapping corresponding:
You can add / change remove any item.
If you want to select pages to be mapped directly, you can use a tool like Geta.DdsAdmin to see what is mapped and / or delete the mappings in the “SiteAttentionModule.Data.PropertySetting” store:
Here you can modify directly or delete all.
If you delete all you will see the automap in the SiteAtetntion Toolbar for that specific page when loaded. See section SiteAttention Toolbar.
8. SiteAttention Toolbar
When SiteAttention is installed you will have the option to add SiteAttention as a gadget in editor mode:
Select SiteAttention and reload the page.
9. Page View
When the gadget is loaded and SiteAttention has been configured you will see the following:
Page Not Mapped View
If you have not mapped the page as described in configuration guide, you will see the following:
Here you can click automap and SiteAttention will automap according to the page.
In this example it also pulls in two keywords from the meta keyword property as described in the configuration:
You can go through each rule and make sure everything is mapped correctly. If changes needed, you can change them in the Admin part under Advanced Mapping.
10. Editing/ View Blocks or Trash
When you edit a block, an image or viewing trash where SiteAttention should not analyze the content, then you will see the following:
11. License Expired View
If your license has expired, you will see the following:
12. Quota Exceeded View
If you have reached your quota limit you will see the following:
Episerver v. 10 or older
To learn more about installation and mapping of SiteAttention for Episerver v. 10 and older, watch the video below.
After installing, you need to activate and configure the plugin.
When first installed you will see the following under CMS →Admin mode → Tools → SiteAttention:
Now, go to CMS → Edit Mode and check if the plugin appears on the right. If it does, it means you've installed it successfully.
You can now continue to the next step - Registration.
If you already have your license key, skip point 2, and go directly to point 3. Activating your account.
Use the plugin to register, then press Try 30 days for free.
You should now receive an email from us with your License key.
3. Activating your account
After you have registered you will receive the following email:
Go to CMS → Admin mode → Tools → SiteAttention → License info and enter the License key you've gotten in the email from us. Then press Save.
Your Instance ID and Instance Name will automatically fill in.
You can change your Instance Name to your domain's name, to make it easily recognizable for everybody in your team. Click Save.
Go to CMS → Edit Mode to make sure that your plugin is active.
It should now look like this:
4. Configuring SiteAttention
Go back to CMS →Admin mode → Tools → SiteAttention
There are two ways of mapping your SiteAttention tool.
Choose the Generic Settings if all your pages consist of the same properties.
If some of your pages consist of different properties than the others, you will need to map each of them separately, using custom settings. This is a more advanced option and requires good knowledge of the properties used on your pages.
Match the SEO factors on the left with the fitting properties used on your pages (on the right).
The mapping is needed to inform your SiteAttention tool about what each property on your pages is used for. Typical information that is important for a search engine is the general page content, the page title and the page description.
Generic settings are applied to all page types that have not been marked Custom Settings. It is possible to map a number of properties to indicate important page information. Enter a single property name or enter a list of comma-separated property names for each property type. You can add as many as needed.
In the example above, all page types with a property called SEOTitle or MetaTitle will be expected to store the Title of the page. When giving recommendations, SiteAttention will base this on the content in the actual property on the page.
Another example is that all properties named MainBody, SecondaryBody or MainContentArea will be expected to contain page content. You can also map custom Header fields (the last three items) if they are set in your Episerver setup. These fields need to be added to the Rich Text content as well. Note that the properties are separated with a comma.
5. Setting up custom settings for a page type
As Episerver can be customized, dependent on installation, you can setup individual settings for different page types. To do this, go to SiteAttention settings page ( CMS → Admin mode → Tools → SiteAttention).
Here, you can find the list of all the page types created for your website. Click on the page type you want to map.
Select Use custom settings for this Page Type and the following expanded view will appear:
By clearing Only show selected built-in properties you will see all built-in properties, which in most cases are not useful for SEO.
It is also possible to show properties of other types than String, LongString and XhtmlString, but in most cases other types than these three are not useful to map.
To do a custom mapping you select which property you want to map and then what kind of content it will have in it by selecting it from the drop-down list as follows:
The alternatives are the same alternatives as in the generic settings so look there for more information about each option.
Press Save to store the new mappings.