Sitecore Placeholder Fallback

September 22, 2015 | Charlie Turano

When implementing Sitecore websites, we sometimes run into a situation where the Content Editor wants to personalize or A/B test components that are common to multiple pages in the site. A good example of this is the header and/or navigation components. The problem we run into is that the components need to behave the same on all pages and it would be very difficult, if not impossible for content editors to maintain these components on all pages on the site. I have seen a few ways of solving this problem, but most solutions had some drawbacks that limited the capabilities of the content editor.

Implementing common renderings

To have common renderings across multiple pages we need to make sure the renderings on each page are the same. This is easily done in Sitecore, but if the content editor wants to personalize or A/B test these items, things get difficult.

Adding Rules to Data Items

One way of solving is to add a rules field to the data items the DataSource of a component points at. The rules would be evaluated at render time and a decision would be made to determine if the item should be shown. This has at least two big drawbacks. The first is that the content editors can't make changes to these items the same way they do for other renderings on the site. Since everything is edited in the rules for the individual items, content editors need to have special procedures for these common components. The second is that it makes A/B testing impossible using the default Sitecore components.

Editing the __Standard values

Using __Standard values to hold common components is a reasonable way to build default functionality into the pages of your site. The presentation details on the __Standard values item is shared across any page item that use the template. This makes it very tempting to use to __Standard values to manage shared page components. The big drawback with this technique is that content editors need to edit the __Standard values if they want to change the behavior of the site. I feel that __Standard values are developer items, and any process that involves content editors manipulating developer items should be avoided at all costs.

A better choice

Fallback is when a value is left blank or empty and the value is retrieved from some other location in a predictable way. Content Editors already understand field fallback, item fallback and language fallback. Why not have fallback functionality on placeholders. Placeholder fallback would use the Sitecore Item hierarchy to implement parent fallback for the contents of a placeholder. The content editor can edit the header and navigation on a top level page in the Experience Editor and it will automatically appear on all child pages. If they want to provide page specific renderings, they can easily do so by adding the proper renderings to any sub-page in the hierarchy. Placeholder fallback will allow personalization and A/B testing automatically work using the out of the box components. As an added benefit, the content editor can customize the renderings exactly like all other items on the site. The customizations will automatically be used on the child pages of the site because the child pages fall back to whatever the parent rendering does.


There are only two main pieces needed to implement fallback renderings. The first is a simple rendering that is placed on the page to indicate where parent renderings should be inserted. This component is added by the __Standard values for all pages and can be removed by the content editor of they want to override the renderings on a specific page. The second component is a pipeline step that runs as part of the mvc.getXmlBasedLayoutDefinition pipeline and calculates the replacement values for the fallback renderings.

Placeholder fallback rendering

When in the experience editor, the rendering presents itself as a square box with a message telling the Content Editor where the actual renderings for the page will come from. We use a controller rendering to implement this. The controller action is very simple and can be located on whatever controller the developer wants:

    /// <summary>
    /// If a fallback rendering is shown on the page, make it invisible.
    /// </summary>
    /// <returns></returns>
    public ActionResult FallbackRendering()
        if (Sitecore.Context.PageMode.IsPageEditor || Sitecore.Context.PageMode.IsPreview)
            return View(new FallbackRenderingInfo
                FallbackLocation = RenderingContext.Current.Rendering.
            return new EmptyResult();



The view for the rendering is also very simple and looks like:

@inherits System.Web.Mvc.WebViewPage<TDS.SitecoreCustomizations.Models.FallbackRenderingInfo>
<div class="fallback-rendering">
    <div>Fallback rendering</div>
    <p>This content may not be edited here.</p>
    <p>Content for this placeholder comes from the page(s) '@Model.FallbackLocation'</p>



The developer may want to implement some css to make the rendering look good on the page. In our case it is a gray box with a black border and the text centered in the box. The rendering also has a rendering parameter template associated with it that allows it to be configured with a comma separated list of placeholder names. These are the placeholders the pipeline step uses to get the parents renderings for the page.

Getting the layout from the parent

The pipeline step to implement Placeholder Fallback is inserted after Sitecore.Mvc.Pipelines.Response.GetXmlBasedLayoutDefinition.GetFromLayoutField, Sitecore.Mvc step in the mvc.getXmlBasedLayoutDefinition pipeline. This step parses the current layout XML, looks for the fallback rendering and replaces it with renderings from an ancestor item.

The code for insert fallback renderings is a little longer than I want to include in the blog, so you can download the .cs file here: InsertFallbackRenderings.cs. I will describe the operation of the class below.

There are two constants in the class. The first is the only one you need to worry about. It is the ID of the fallback rendering item in Sitecore. It is called FALLBACK_ RENDERING_ID. You should change this constant to match the ID of the fallback rendering item you create.
ProcessFallbackRendering method
The ProcessFallbackRendering method does most of the hard work. It looks for the fallback renderings in the current layout Xml. Then it parses the parameters to find the placeholder names. If the page is in page editor mode, it locates the replacement renderings, but puts the placeholder names and parent path in the fallback rendering XML instead of doing the actual fallback. The placeholder and parent paths are picked up by the fallback rendering and shown to the content editor so they know where the actual renderings will come from. If the page is not is page editor mode, the replacement renderings are inserted in the current layout Xml and the placeholder rendering is removed.
Gets the layout Xml for each parent until the list of required placeholders has been retrieved. This method uses calls to a delegate Func<> to determine if the layout for the parent item is actually useful. This allows the traverse functionality to be reused multiple ways.
Determines which renderings in the passed layout XML are renderings that can be added to the placeholder. If is sees a fallback rendering in the placeholder, it is bypassed, allowing parent renderings to be searched.
Returns the layout Xml for a page using the same API as Sitecore does to determine the layout for a page. This ensures that the rules for the shared/final renderings are evaluated correctly.

Final Thoughts

This solution was well received by the content editors who have used it. They preferred it over other implementations because it provided an editing experience very much like all the other editing experiences on the site. They also found it very easy to understand. The implementation was done on Sitecore 8 Update 3, 4 & 5. It is only compatible with MVC renderings, but could most likely be ported to ASP.Net Sublayouts.

Sitecore MVC Development Placeholders

Related Blog Posts

Sitecore to acquire Hedgehog
Hedgehog is thrilled to announce we have entered into a definitive agreement to be acquired by Sitecore.
SUGCON Europe 2019: A Hedgehog Live Chat
Hedgehog is headed for London! Our SUGCON Europe team talks sessions, SUGCON memories and shares tips for getting the most out of the conference.&nbsp;<span style="white-space: pre;"> </span>
Hedgehog Announces the Release of TDS Classic 5.8
Hedgehog announced the release of TDS Classic 5.8. The newest update now supports Azure and Visual Studio 2019.
Sitecore, Docker, SUGCON - Oh My!
Sitecore MVP Sean Holmesby took the time to talk with us about his presentation and SUGCON.
Enhanced Content Editing for Sitecore: An Avtor Live Chat
In our first product-centered live chat, the team covers Avtor, the essential Sitecore content editing tool.
Hedgehog Announces Release of Avtor
Hedgehog, a digital consultancy engineering high - performance, multi-channel solutions, today announced the release of a brand-new product called Avtor, a part of the Team Development for Sitecore Essential Collection.
How Feydra Improves Front-End Development for Sitecore
Feydra offers a more efficient modern approach to front-end development workflow for Sitecore.
Guide to Sitecore Packaging
Development of features and components requires a set of Sitecore items to be packaged - things like renderings and templates. With TDS Classic, Sitecore developers can automate the packaging process.&nbsp;
TDS Classic: Content File Sync
Content File Sync is a fantastic time saver for any Sitecore developer.
TDS Classic How-To: Perform Unattended Installation of TDS Classic for Visual Studio 2017
The TDS Classic version for Visual Studio 2017 is installed a bit differently than previous versions; the process is separated in two parts and performed by two different installers.
Sitecore Security and Strengthening Your Sitecore Platform
Improve the security of your Sitecore platform with these tips
TDS Classic 5.7 - Lightning Deploy
Lightning Deploy Mode&nbsp;can be used to enable Lightning Mode for all deployments that utilize the TDS Sitecore Connector in their configuration, improving their speed and efficiency.
TDS Classic 5.7 - Lightning Sync
Lightning Sync allows both sync and quick push operations to use TDS Classic 5.7's new Lightning Mode feature
TDS Classic 5.7 - Solution Wide Sync
A simple new feature in TDS Classic 5.7, Solution Wide Sync makes a big difference when working with many TDS Classic projects in a solution.
TDS Classic 5.7 - Lightning Mode
Lightning Mode helps to improve the speed and efficiency of both deploy and sync operations.&nbsp;This enhancement is achieved by modifying how item comparisons are performed.
Sitecore Experience Accelerator: Missing Video Description
<p>A fix for the missing Video Description field in SXA 1.4</p>
RAZL Best Practices: Lightning Mode and Deep Compare
From scheduling Razl scripts to sync changes between Production and QA environments to keeping logs from scheduled Razl scripts, our team has a few tips and tricks to make the Razl experience even better.
Azure Sitecore Deployment: Deploying to a Slot
Setting up Azure staging slots, so the next release of our project can be placed there, allows us to deploy the new code to a private website (the slot), and test it before pushing it live. We are going to script this process to make it easier for the devops team to automate.
TDS Classic Best Practices: NuGet Build Components and TDS Classic .user configs
There are certain systems and processes that you can put in place to make a TDS Classic project run more smoothly. We're highlighting the best practices that our team recommends for getting the most out of TDS Classic.
Azure Sitecore Deployment: Adding Project's Code and Items to the Azure Deployment
Modify the scripts so that the compiled LaunchSitecore site is also provisioned into the new XP environment.
TDS Classic Best Practices: Bundle Packages, Delta Builds and Delta Packages
Following TDS Classic best practices, like using Delta Builds and Delta Packages, can make the entire development experience run much more smoothly.
Azure Sitecore Deployment: Adding Custom Modules
Modify the previous install so that the initial install contains the Sitecore Package Deployer module. It is an excellent way to enable continuous integration to the website.
TDS Classic Best Practices: Validators and the Sitecore Package Deployer
TDS Classic can be used in many ways, but the goal is always the same: make development (and developers lives) easier. Whether it's using the Sitecore Package Deployer or using validators, following best practices can make your entire experience run much more smoothly.
Azure Sitecore Deployment: Preparing the Default Scripts and Packages
Preparing the default packages for a Sitecore Azure deployment and extending to add a custom module to the install.<br> <br> <br> <br> <br>
Azure Sitecore Deployment: Setting Up the Solution and VSO Build
<p>The first in our series on setting up a Sitecore instance on Azure, with an initial deployment that includes custom built modules as add-ons to the setup.</p>
Troubleshoot and Prevent Failed TDS Classic Project Builds
When building an .update package with TDS Classic, the build might fail with no additional information. From increasing log verbosity to using validators, there are ways to minimize or prevent this type of error.
TDS Classic How-To: Disable Automatic Code Generation
Code Generation is automatically triggered after every change in the TDS Project tree. If a project contains many items, users can disable this feature for their convenience.
TDS Classic Sitecore Deploy Folder
Sitecore Deploy Folder is a setting, located in the build tab of the TDS Classic Project's Properties page, and used to tell TDS Classic where the webroot is located.<br>
TDS Classic Builds on Jenkins Build Server with NuGet Packages
Our simple scenario includes 2 developers using TDS Classic and checking-in changes to source control. The Jenkins build server takes the changes and performs the build, and then deploys the created package to two Sitecore environments.
Features to Improve Sitecore Development: TDS Classic Strikes Back
Each and every feature in TDS Classic is aimed at helping developers. Whether the feature is out front or running quietly in the background the goal is always the same: make the development experience better. &nbsp;&nbsp;
Feydra and the Virtual Sandbox
Feydra virtualizes all front end assets (css, js &amp; cshtml) of a Sitecore instance. With Feydra, front-end developers can commit their changes to Source Control without requiring the intervention of a back-end developer. We call it a virtual sandbox.&nbsp;
Feydra Frequently Asked Questions
Answering a number of excellent questions we've gotten from the community regarding Feydra, including how long it takes to set up a Feydra environment and how to install the product.&nbsp;
TDS Classic Features to Improve Sitecore Development
Each version of TDS Classic comes with the same goal: to make Sitecore development and, by extension, developers, lives easier. Every feature in our products is aimed at making the process better - some of these features aren't quite as well-known as others, but they all help smooth and improve the development experience.
Deployment Properties and the Deployment Property Manager
When working with TDS Classic, you will eventually need to deploy your items to a Sitecore instance and you might not want the default behavior of every item in your TDS project deploying every time. This is where the TDS Sitecore Deployment Property Manager comes in!
Feydra: A Front-End Assessment
Feydra allowed me to start building the front-end in a very short time with no Sitecore experience, and it let me use tools that I was comfortable and familiar with.
Feydra: A Quick Start Guide
A step-by-step guide for installing, configuring and, most importantly, using Feydra from the front-end.
TDS Classic 5.6 Feature Spotlight - Prevent Deployment of Incorrect Assemblies
This feature, new to TDS Classic 5.6, will prevent a solution from deploying unless all assemblies (except the excluded assemblies we allow you to specify) match what exists in your webroot.&nbsp;
Feydra from the Front-End
Feydra eliminates common roadblocks for designers and front-end developers working on Sitecore projects by getting them up and running more quickly and allowing them to use the development environment and workflow tools they prefer.&nbsp;
FxCop Rules for Sitecore Helix
TDS How To: Install the TDS Connector for Rocks 2.0
Manually install the TDS connector for Sitecore Rocks 2.0
Create TDS Classic Custom Post Deploy Step
Team Development for Sitecore Classic version 5.5 allows developers to add post deployment steps to to their deployments and update packages. TDS Classic has used post deployment steps internally to perform a number of useful functions. Many of the developers using TDS Classic have requested the ability to add their own post deploy functionality. With the release of TDS Classic 5.5 in early 2016, this functionality is now available.
Using NuGet Packages in TDS
New to TDS 5.5 is the ability to create and consume NuGet packages in your TDS project, allowing developers to capture their Sitecore items and easily distribute them across multiple teams.
Occasional Issue Seen with TDS Installer
When upgrading to TDS 5.5.0.x from an older version and trying to load a solution with a TDS project inside, the following error might occur:
TDS: The Evolution of Auto-Sync
Auto-Sync has been described as a new feature, but in reality has existed in TDS since 2010 and has taken a new form in TDS 5.5, due to be released March 22, 2016
TDS for SC Hackathon 2016
For all those participating in the Sitecore Hackathon, check out our Habitat for TDS and some other cool surprises.
3 Critical (and Common) Sitecore Wellness Issues
There are a lot of factors that can adversely affect Sitecore and its performance. There a few common errors that we almost always uncover when running a wellness evaluation.
Config Transforms for Config Files
If you don't want to use a third party development tool for your config transforms, I have good news. Config transforms are supported natively within TDS!
Package Installer from the Command Line
The TDS package installer allows you to install packages through the command line. Learn how...<br>
Customizing WFFM in Sitecore 8
WFFM is a great tool for allowing content editors to build custom forms. The main issue with WFFM is that it doesn't always generate the HTML we need for the site. This blog post shows how to customize the HTML in different ways for each sub-site.
Robust MVC Rendering Exception Handler
While working on a recent Sitecore MVC implementation, I started to think about how Sitecore handles errors in the MVC components on a page. In past implementations, I had added a processor to the mvc.exception pipeline to route the user to the error page for the current site. This works reasonably well, but I began to notice a few drawbacks.
Context Based Datasource
Creating and maintaining your datasources in your content tree can be challenging. This blog post shows how to get Sitecore to help organize the datasources.
Predefined Roles and Creating Your Own
What are the out of the box Sitecore roles, when should you make your own, and how do you do it?
New Build for TDS 5.0!
A couple bugs were reported over the last few months. We've been able to fix the bugs and now have a stable CTP version for use.
It's finally here!
Team Development for Sitecore has finally been released go download it now!
Team Development for Sitecore Webinar
Our Sitecore MVPs Charlie and Sean recently did a demo of TDS to all Sitecore partners. We recorded the demo to share with the world.