This topic describes the NuGet packages and initial configuration for the setup of the Content Recommendations integration for Episerver CMS.
What is included in the integration NuGet package
- A UI module that integrates the Content Recommendations dashboards and configuration in the Episerver Platform navigation.
- Automatically adds visitor behavior tracking to pages, to build user behavior profiles that can give relevant content recommendations.
- A Content Recommendations block that editors can add to pages where they want content recommendations to appear.
- A subscription to the Content Recommendations service and the appropriate configuration information for the environment (see Configuration section below), and user login credentials for the Content Recommendations UI.
- An episerver CMS website implementation that uses RenderRequiredClientResources in the HTML head element. (This is where the tracking script will be injected.)
- The website implementation has been set up for Collecting metadata.
- The website is open to the public internet so the Content Recommendations service can reach it and index the site content.
Important: Before installing Content Recommendations, make sure you have widget deliveries set up. Otherwise, you will not see any widget deliveries in the drop-down widget selector.
Install the EPiServer.Personalization.Content.UI package in your Episerver solution. If you have already set up your NuGet feed, skip to Step 6.
- In Visual Studio, select Tools > NuGet Package Manager > Package Manager Settings.
- Select Package Manager > Package Sources.
- Click Add (+) to add a new package source.
- Add Episerver as Name, and the package Source https://nuget.episerver.com/feed/packages.svc/.
- Click OK.
Note: NuGet package manager has to be version 2.8.50126.477 or higher to install Episerver packages.
- Open the solution file in Visual Studio and make sure the solution file is saved (required to make the NuGet tools available).
- In the Solution Explorer, right-click on References for the project, and select Manage NuGet Packages.
- Select Updates for the Episerver package source, to locate available updates for your solution, and click Update for the desired packages.
- When the installation/update is completed, rebuild the solution.
- See product-specific updating steps for steps required to finalize the update.
Add the required configuration keys (see the Configuration section).
The following web.config appSetting keys are used to set up the integration. For example:
<!-- Episerver Content Recommendations --> <add key="episerver:personalization.content.Environment" value="emea01.idio.episerver.net" /> <add key="episerver:personalization.content.ClientId" value="69b1837893424a28b269fd94ab6b30c0" /> <add key="episerver:personalization.content.ApiToken" value="PQZ7KEZMESE3N212D0Y0" /> <instanceName = value "carpetright">
|episerver:personalization.content.Environment||The environment for the account. For production environments this is idio.co but could be staging.idio.co for the environment, and so on.|
|episerver:personalization.content.ClientName||[New in 0.3.0]
The friendly name of the client account in the service that is used to access the UI, such as mywebsite in https://manager.idio.co/mywebsite
|episerver:personalization.content.ClientId||The alphanumeric client identifier of the account in the service that is sent with the tracking script.|
|episerver:personalization.content.ApiToken||The token used to authenticate to the API endpoint that provides available recommendation widgets to the property on the Content Recommendations block.|
|episerver:personalization.content.DisableDefaultTracking||Optional. If set to true, the default tracking script is not rendered in the HTML head section. Use this if you want to customize the tracking script or already have the tracking script included and do not want to remove it.|
Adding recommendations to a page
At least one widget delivery needs to be set up in the Engage/Deliveries view of the Content Recommendations UI, see Setting up deliveries.
Adding a recommendation block
- In CMS edit view, create and place a new instance of the Content Recommendations block on a page.
- Use the All Properties view for the block to set:
- The number of recommendations to show.
- Which widget delivery to pull recommendations from.
- An HTML fragment using templates for content properties to render the recommendation.
Note: Omit the script element surrounding the template because it is automatically included by the integration.
- Publish the block and the page.
Last updated: Jan 31, 2020