SXA Upgrades – A Trap for Young Players

 



Sitecore SXA is my favorite way of developing new sites, but there is one tricky trap that can cause you headaches when upgrade time rolls round.

And it’s a simple one; when installed, SXA creates multiple branches in the Content tree where SXA specific items are stored. Generally, they are organised into a Helix construct, so for each part of the tree that SXA creates, there will be three folders:

  • Feature – don’t mess with it.
  • Foundation – leave it alone.
  • Project – All yours buddy

Fine and good until you start extending and developing. SXA retains control over these specific nodes, and when it’s time to upgrade they are over written, which means if your project items are stored in any of these folders, then blammo! They are toast.

This is How We (Don’t) Do It

Here is a good example, a customer recently upgraded their 9.0 instance to 9.3. It was mostly a well-constructed, standard SXA build but with one tiny and crucial detail.

First a little background, SXA has always depending on its own grid systems. In the case of 9.0 this includes Bootstrap 3 but not Bootstrap 4. Of course, developers never want to use an out-of-date grid system, especially when the design agency has mocked the site up using Bootstrap 4.

The solution in this case (and a rather brave move I must say), was to create their own custom grid system, no minor undertaking it must be said considering all the breakpoints and classes that need to be defined.

The grids for SXA are stored and configured under this path:

/sitecore/system/Settings/Feature/Experience Accelerator

As you might note above, this is from a 9.0 instance and the custom grid that has been created is shown as Bootstrap4, named almost identically to the existing Bootstrap grid above it, enough to make it hard to spot.

So, when an SXA upgrade is performed, this whole node will be overwritten, and the custom grid will go bye bye. The upshot of this is that upgrade will complete successfully, but there will be nothing shown on the page, because the chosen grid does not exist anymore. The simple solution is to store your custom items outside of any folder controlled by SXA – always.

In this case the custom grid should have been moved out of SXA folder and placed under:

/sitecore/system/Settings/Project

and then referenced correctly on this item:

/sitecore/content/[YOUR SITE]/Site/Settings


Areas you should pay attention to, and never create custom items in include:

  • /sitecore/layout/Layouts/Feature/Experience Accelerator
  • /sitecore/layout/Layouts/Foundation/Experience Accelerator
  • /sitecore/layout/Renderings/Feature/Experience Accelerator
  • /sitecore/layout/Renderings/Foundation/Experience Accelerator
  • /sitecore/system/Settings/Feature/Experience Accelerator
  • /sitecore/system/Settings/Foundation/Experience Accelerator
  • /sitecore/templates/Feature/Experience Accelerator
  • /sitecore/templates/Foundation/Experience Accelerator

And that’s all, a simple rule that all SXA developers to follow to allow for clean SXA upgrades without mysterious disappearing items.

Comments

Post a Comment

Popular posts from this blog

Lift and Shift to Sitecore SXA – Migration the Easy Way

Image
  So, this is a bit of a commercial recipe I am happy to share, garnered, and honed from several projects over a 2-year period. Often, clients are mostly happy with Sitecore as a platform, even though it is likely they haven’t leveraged the experience functionality. They may be using anything from version 6 to 8.2 and have an ok content management setup, probably with a custom framework from a previous partner. They don’t explicitly have a desire to re-platform, but the site is looking a bit tired and they have thought there might be some business value in this newfangled personalization stuff. They are also a bit over, paying to maintain a legacy codebase that is limiting them from really tapping into the cool stuff in Sitecore. And they just commissioned their design agency to make ‘em something purty. Well, this is a sweet spot for SXA migration, with the one proviso – the customer checks their license with their Sitecore rep before proceeding, to make sure they can get the late...
Read more

Bootstrap 4 Components – Getting fancy with Scriban & Sitecore SXA

Image
  Sitecore SXA includes components called composites, things like accordions, tabs etc. OOTB they are ok, but you still must fiddle about with alternate views to have full control, they also don’t have rendering variants like other simple components. So, unless you are happy to try and torment these poor things into fancy pants UX stars, you were a little stuck. But then Scriban arrived and all your front ends are belong to us. Here are some of the cool OOTB Bootstrap components you can put together easily with Scriban. Approach You’ll need to make sure you have all the bootstrap elements, specifically:  https://maxcdn.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css   https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js   https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.0/umd/popper.min.js   https://maxcdn.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js You will likely have jQuery already installed – check your version by inspecting ...
Read more

It’s The Little Things - Personalization is the elephant in the room

Image
  Small Things with Big Impacts At a Sitecore Symposium in Australia, many years ago, Lars Birkholm Petersen asked the well-known question ‘How Do You Eat an Elephant”. The answer is of course, “A bite at a time”. He was referring to personalization in Sitecore or any platform for that matter. How personalization is the elephant in the room that gets ignored at first and sidelined later, which is a pity as the main advantage of an Experience Management platform is to… well… manage experiences. It’s safe to say that any website that doesn’t take their customer’s experience as the starting point in design - and this is lots of them - will perform far worse than one that does. Hey, companies! It’s all about your customer, not all about you! In this article, I’d like to look at a few very simple scenarios where a tiny piece of information about a customer can make a huge difference to customer value for the business. The Up-Sell Cross-Sell In this scenario a customer was selling m...
Read more