SaaS CMS has officially launched! Learn more now.

Manoj Kumawat
Jan 3, 2020
  7489
(0 votes)

Using simple address in URL

In this blog post I'll demostrate how you can utilize episerver's Simple address in URL with an Initialization module.

The simple address can be used as a direct address/Route node without language node included in URL.

See Below - 

This is an external URL which you can utilize for promotional contents as News Events, Press Releases etc. 

Let's create an initialization module that will parse the URL after a virtual path is created.

Step 1 - Define and initialize services to use

private bool initialized = false;
private IContentLoader contentLoader;
private IContentRouteEvents contentRouteEvents;

public void Initialize(InitializationEngine context)
{
	if (!initialized)
	{
		contentLoader = context.Locate.Advanced.GetInstance<IContentLoader>();
		contentRouteEvents = context.Locate.Advanced.GetInstance<IContentRouteEvents>();
		contentRouteEvents.CreatedVirtualPath += ContentRouteEvents_CreatedVirtualPath;
		initialized = true;
	}
}

Above,

The contentLoader would be used to cast the URL to a Page type.

The contentRouteEvents would keep tracks of URLs (virtual paths) being created. Note, that the delegate method ContentRouteEvents_CreatedVirtualPath will only be raised when outgoing virtual path has been created.

The property initialized will initialize the Module only once and it makes sure that it should not be initialized more than once. 

This Event handler will be explained in next step. 

Step 2 - Managing route via Route Event Handler

In previous step we've defined a delegate method that should be raised when the path is created. Now let's take a look how you can use the URL/Path to cast in a page and utilize it's simple address.

private void ContentRouteEvents_CreatedVirtualPath(object sender, UrlBuilderEventArgs e)
{
	var contentLink = e.RouteValues[RoutingConstants.NodeKey] as ContentReference;
	if (!ContentReference.IsNullOrEmpty(contentLink))
	{
		var lang = e.RouteValues[RoutingConstants.LanguageKey] as string;
		var langSelector = string.IsNullOrEmpty(lang) ? LanguageSelector.AutoDetect() : new LanguageSelector(lang);
		var page = contentLoader.Get<IContent>(contentLink, langSelector) as PageData;
		if (page != null && !string.IsNullOrEmpty(page.ExternalURL))
		{
			e.UrlBuilder.Path = page.ExternalURL;
		}
	}
}

Above, 

Read the RouteValues, i.e. language and node name. For instance http://localhost:52426/en/alloy-track <-- language is 'en' and node is 'alloy-track'

Cast the URL as page Data <-- var page = contentLoader.Get<IContent>(contentLink, langSelector) as PageData

Finally, If the Simple address field is not blank then use the external URL instead of default route URL.

Verifying

When you have the external/Simple Address defined in Episerver then the external URL would be used as the link address of that item. See Below 

Cheers!

Jan 03, 2020

Comments

Ben Nitti
Ben Nitti Jul 6, 2020 10:00 PM

Exactly what I was looking to do, thanks!

Please login to comment.
Latest blogs
Creating Custom Actors for Optimizely Forms

Optimizely Forms is a powerful tool for creating web forms for various purposes such as registrations, job applications, surveys, etc. By default,...

Nahid | Jul 16, 2024

Optimizely SaaS CMS Concepts and Terminologies

Whether you're a new user of Optimizely CMS or a veteran who have been through the evolution of it, the SaaS CMS is bringing some new concepts and...

Patrick Lam | Jul 15, 2024

How to have a link plugin with extra link id attribute in TinyMce

Introduce Optimizely CMS Editing is using TinyMce for editing rich-text content. We need to use this control a lot in CMS site for kind of WYSWYG...

Binh Nguyen Thi | Jul 13, 2024

Create your first demo site with Optimizely SaaS/Visual Builder

Hello everyone, We are very excited about the launch of our SaaS CMS and the new Visual Builder that comes with it. Since it is the first time you'...

Patrick Lam | Jul 11, 2024