Try our conversational search powered by Generative AI!

Jacob Khan
Apr 5, 2016
  7844
(6 votes)

Preview Content in View Mode

One of our enterprise customers recently approached me with an interesting challenge. They wanted to generate a URL of unpublished content and send it to an external party for validation of look and feel and an obligatory “thumbs up” before publishing.

In CMS 6 this could be achieved by going to the template URL and adding the version id. www.alloy.com/templates/pages/standardpage.aspx?id=5_5

However editors wouldn’t know the template / controller in newer version of Episerver, so I needed a different way of accomplishing this.

I used partial routing to fetch the previous version and show that in the URL.

 public class PreviewPartialRouter : IPartialRouter<SitePageData, PageVersion>
    {

        public PartialRouteData GetPartialVirtualPath(PageVersion version, string language, RouteValueDictionary routeValues, RequestContext requestContext)
        {
            var contentLink = ContentRoute.GetValue("node", requestContext, routeValues) as ContentReference;
         
            if (PageEditing.PageIsInEditMode)
            {
                return null;
            }

            return new PartialRouteData
            {
                BasePathRoot = contentLink,
                PartialVirtualPath = String.Format("{0}/", version.ToString())
            };

        }


        public object RoutePartial(SitePageData content, EPiServer.Web.Routing.Segments.SegmentContext segmentContext)
        {
            var namePart = segmentContext.GetNextValue(segmentContext.RemainingPath);
            if (!String.IsNullOrEmpty(namePart.Next))
            {
                var version = HttpUtility.UrlDecode(namePart.Next);
                try
                {
                    var versionNumber = new ContentReference(version);

                    if (versionNumber != null)
                    {
                        var remaingPath = namePart.Remaining;
                        //Update RemainingPath on context.
                        segmentContext.RemainingPath = remaingPath;
                        var versionRepository = EPiServer.ServiceLocation.ServiceLocator.Current.GetInstance<IContentVersionRepository>();

                        var ActualVersion = versionRepository.Load(versionNumber);

                        segmentContext.RoutedContentLink = ActualVersion.ContentLink;
                        var contentRepository = EPiServer.ServiceLocation.ServiceLocator.Current.GetInstance<IContentLoader>();
                        var pd = contentRepository.Get<SitePageData>(ActualVersion.ContentLink);
                        segmentContext.SetCustomRouteData<PageVersion>("version", (PageVersion)ActualVersion);


                        return pd;
                    }        
                 }catch{
                    return content;
                 }

              

                       
            }

            return null;
        }	

This example is with Alloy, where I use sitepagedata as my base. As you can see, I am getting a request in for a partial route meaning the main page url /”something”. “Something” refers to ContentReference.ID + “_” + Version Workid (5_18). This enables me to switch the current version to an older one.

I also need to register my partial route:

 [InitializableModule]
    [ModuleDependency(typeof(EPiServer.Web.InitializationModule))]
    public class PreviewInitialization : IInitializableModule
    {
        public void Initialize(InitializationEngine context)
        {
          
            var partialRouter = new PreviewPartialRouter();

            RouteTable.Routes.RegisterPartialRouter<SitePageData, PageVersion>(partialRouter);

        }

      
        public void Preload(string[] parameters) { }

        public void Uninitialize(InitializationEngine context)
        {
           
    
        }
    }

Rather simple if you ask me, but works well. To get the version ID, go into the version gadget and pick the previous version you would like to send. Since it isn’t always super easy to find a version and work id, I created a gadget which creates a simple version link for you

PreviewContent

You can download the code here. Just place it in your project under the Business folder if you are using Alloy. In your own project, make sure to fix the path for the PreviewComponent and any namespace or SitePageData issues to your base

https://drive.google.com/open?id=0B_XVbM6ery9FcXEzbkZ4Skt3YUE
Apr 05, 2016

Comments

Marija Jemuovic
Marija Jemuovic Apr 6, 2016 01:46 PM

Very useful, thx!

Arve Systad
Arve Systad Apr 7, 2016 03:34 PM

Should be implemented right into the product itself, I'd say. 

That said, you DO have the actual preview button (top left, rectangle with magnifying glass) that removes all editing stuff/dojo-widget-mumbojumbo and shows the page as  is. Works fairly well too :p

Apr 7, 2016 04:26 PM

Nice solution! And the next challange is to activate the preview feature used in the Projects feature so all blocks that still are unpulished on the page also becomes visible...

Apr 7, 2016 10:45 PM

@fredrik, great idea to think about the projects instead. Maybe Just add the Project in the URL and then load in the Project view. I'll get to work :)

@arne, you are right, the preview button works for this but we sometimes have the requirements that people outside of Epi edit mode wants to review content. 

eGandalf
eGandalf May 25, 2016 11:32 PM

If you give the Anonymous role Read + Change permissions to the content the anonymous preview works. I *think* this would be safe as any anonymous (non-authenticated) user would never have access to the authoring interface or API-level access (keep the role out of the ServiceAPI, for example). Once someone is authenticated, they're no longer anonymous. 

Barring some other solution, I'd probably implement an IP-range or domain restriction in Jacob's code above so that it would only function if the incoming request was from the right network or was against the right domain - say an internal authoring domain.

Great solution and easy to implement!

Jared Wooden
Jared Wooden Oct 12, 2016 07:35 PM

@jacob, did you ever get this working with projects? I was working on something similar for one of our customers when I came across this [much simpler] alternative. Thanks!

Please login to comment.
Latest blogs
Optimizely and the never-ending story of the missing globe!

I've worked with Optimizely CMS for 14 years, and there are two things I'm obsessed with: Link validation and the globe that keeps disappearing on...

Tomas Hensrud Gulla | Apr 18, 2024 | Syndicated blog

Visitor Groups Usage Report For Optimizely CMS 12

This add-on offers detailed information on how visitor groups are used and how effective they are within Optimizely CMS. Editors can monitor and...

Adnan Zameer | Apr 18, 2024 | Syndicated blog

Azure AI Language – Abstractive Summarisation in Optimizely CMS

In this article, I show how the abstraction summarisation feature provided by the Azure AI Language platform, can be used within Optimizely CMS to...

Anil Patel | Apr 18, 2024 | Syndicated blog

Fix your Search & Navigation (Find) indexing job, please

Once upon a time, a colleague asked me to look into a customer database with weird spikes in database log usage. (You might start to wonder why I a...

Quan Mai | Apr 17, 2024 | Syndicated blog