Son Do
Mar 10, 2015
(1 votes)

Extend UniqueSeoGenerator to replace SEO URL generation in EPiServer Commerce 8.9

In EPiServer Commerce 7.5, we had Magnus Rahl's post about replacing SEO URL generation. And one more time from EPiServer Commerce 8.0 and above still support two different approaches for routing to catalog content. However, there are some improvements to make creating custom SEO easier, more flexible and increase performance.

By default the SEO URL is generated from content name, language branch name and “file extension” .aspx appended. SEO uri is look like “Tops-Tunics-LongSleeve-en.aspx” and with hierarchical route using the Name in URL property, it become /catalog/category/subcategory/ and URL segment.

And now, we can customize SEO URL by extending Mediachase.Commerce.Catalog.Data.UniqueSeoGenerator

Generating your own SEO URLs

The SEO URL generation is handled by the Mediachase.Commerce.Catalog.Data.UniqueSeoGenerator class. We can override the generating method:


Default value



GenerateSeoUri(string name, string languageCode, bool includeRandomToken)

Default generate Uri like <name>-<randomToken>-<languageCode>.aspx
Sample: tops-tunics-longsleeve-en.aspx or tops-tunics-longsleeve-asdfghjk-en.aspx

GenerateUriSegment(string name, bool includeRandomToken)

Default generate Uri like <name>-<randomToken>
Sample: tops-tunics-longsleeve or tops-tunics-longsleeve-asdfghjk



Sample extend class:

public class ExtendUniqueSeoGenerator : UniqueSeoGenerator
	protected override string UriExtension
			// Default value is ".aspx"
			return ".html";

	public override string GenerateSeoUri(string name, string languageCode, bool includeRandomToken)
		// When extend UniqueSeoGenerator, Uri will become: tops_tunics_longsleeve_en.aspx or tops_tunics_longsleeve_en_asdfghjk.aspx
		return includeRandomToken
			? String.Format("{0}_{1}_{2}{3}", CommerceHelper.CleanUrlField(name), languageCode, GetRandomToken(), UriExtension)
			: String.Format("{0}_{1}{2}", CommerceHelper.CleanUrlField(name), languageCode, UriExtension);

	public override string GenerateUriSegment(string name, bool includeRandomToken)
		// When extend UniqueSeoGenerator, UriSegment will become: tops_tunics_longsleeve or tops_tunics_longsleeve_asdfghjk
		return includeRandomToken
			? String.Format("{0}_{1}", UrlSegment.GetUrlFriendlySegment(name), GetRandomToken())
			: UrlSegment.GetUrlFriendlySegment(name);

	protected override string GetRandomToken()
		var chars = "abcdefghijklmnopqrstuvwzyz1234567890";
		var random = new Random();
		var result = new string(
			Enumerable.Repeat(chars, 8)
					  .Select(s => s[random.Next(s.Length)])
		return result;

GenerateUri and GenerateUriSegment method will be called when data has the same Uri (or UriSegment) that is existed.To make use of your implementation you need an initialization module to replace the configuration in the container:

using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.ServiceLocation;
using EPiServer.Commerce.SampleMvc.Business;
using Mediachase.Commerce.Catalog.Data;
namespace EPiServer.Commerce.SampleMvc
    public class Initialization : IConfigurableModule
        public void Initialize(InitializationEngine context)
        public void Preload(string[] parameters)
        public void Uninitialize(InitializationEngine context)
        public void ConfigureContainer(ServiceConfigurationContext context)
            context.Container.Configure(c => c.For< UniqueSeoGenerator>().Use<ExtendUniqueSeoGenerator>());
Mar 10, 2015


K Khan
K Khan Mar 10, 2015 10:21 AM

Thanks! :)

K Khan
K Khan Mar 12, 2015 11:43 AM

a related article for older versions

Please login to comment.
Latest blogs
Optimizely For you Intranet

Having been at Optimizely and in the CMS industry for nearly 16 years I have seen clients’ intranet requirements go from a simple site just to hous...

Robert Folan | Sep 22, 2023

Vulnerability in EPiServer.GoogleAnalytics v3 and v4

Introduction A potential security vulnerability was detected for Optimizely Google Analytics addon (including EPiServer.GoogleAnalytics and...

Bien Nguyen | Sep 20, 2023

Overriding Optimizely’s Content Recommendations Block to Implement Custom Recommendations

Introduction The Content Recommendations add-on for Optimizely CMS dynamically recommends content from your site tailored to the interests of each...

abritt | Sep 13, 2023 | Syndicated blog

Developer contest! Install the AI Assistant and Win Bose QC45 Headphones!

We are thrilled to announce a developer contest where you have the chance to win a pair of Bose Headphones. The goal is to be the first developer t...

Luc Gosso (MVP) | Sep 7, 2023 | Syndicated blog