Challenge
Recently worked on couple of Sitecore upgrade projects, where we used TDS’s update package feature in release mode. So, we can automate package installation process using CI/CD tools.
This feature, Just works! But recently we faced two challenges which I would like to share with you. In case, you are also facing the same.
Solution
Some Basics:
Before we talk about specific errors and solutions. Would like to share with you about how Package generation works? [If you already know about this, feel free to skip this section and move to next section]
- I strongly recommend you to read this : https://www.hhogdev.com/help/tds/proppackaging
- For this feature to work – You’ve to ensure that you’ve following configurations:
Above list will work for < Sitecore 9.X version. But you need to have few additional DLLs for your Sitecore 9.X+ version.
- Sitecore.Kernel
- Sitecore.Update
- Sitecore.Log
- Sitecore.Zip
- Microsoft.Extensions.DependencyInjection.Abstractions
- Microsoft.Extensions.Logging.Abstractions
- “The package builder failed. Please set the build logging level to Normal or Detailed and see the build output log for more information on the failure.”
We got above error when we were trying to use TDS package generation feature with TDS Version 6.0.0.12 and Sitecore 9.3:
As you can see above error, doesn’t provide much information about the exact error. We enabled detailed logging as explained in this post : https://sitecorebasics.wordpress.com/2017/03/02/tds-error-while-generating-update-package/
After doing above configurations, we could find following entry from log :
Looking for Sitecore assemblies in C:\projects\SCBasics\SC-New\Sitecore\packages
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Sitecore.Kernel.9.3.0\lib\net471\Sitecore.Kernel.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Sitecore.Logging.9.3.0\lib\net471\Sitecore.Logging.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Sitecore.Update.9.3.0\lib\net471\Sitecore.Update.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Sitecore.Zip.9.3.0\lib\net471\Sitecore.Zip.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Microsoft.Extensions.DependencyInjection.2.1.1\lib\net461\Microsoft.Extensions.DependencyInjection.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Microsoft.Extensions.DependencyInjection.2.1.1\lib\netcoreapp2.0\Microsoft.Extensions.DependencyInjection.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Microsoft.Extensions.DependencyInjection.2.1.1\lib\netstandard2.0\Microsoft.Extensions.DependencyInjection.dll
Found assembly C:\projects\SCBasics\SC-New\Sitecore\packages\Microsoft.Extensions.DependencyInjection.Abstractions.2.1.1\lib\netstandard2.0\Microsoft.Extensions.DependencyInjection.Abstractions.dll
Exception Could not load file or assembly ‘Microsoft.Extensions.Logging, Version=2.1.1.0, Culture=neutral, PublicKeyToken=adb9793829ddae60’ or one of its dependencies. The system cannot find the file specified.(System.IO.FileNotFoundException):
at Sitecore.DependencyInjection.DefaultSitecoreServicesConfigurator.Configure(IServiceCollection serviceCollection)
at Sitecore.DependencyInjection.BaseServicesConfiguratorFactory.Configure(IServiceCollection serviceCollection)
at Sitecore.DependencyInjection.BaseServiceProviderBuilder.ConfigureServiceCollection()
at Sitecore.DependencyInjection.ServiceLocator.ConfigureServiceProvider()
at Sitecore.DependencyInjection.ServiceLocator.get_ServiceProvider()
at Sitecore.Configuration.Settings.<>c.<.cctor>b__351_0()
at System.Lazy1.CreateValue() at System.Lazy1.LazyInitValue()
at Sitecore.Update.Update.Serialization.SerializerFactory.GetSerializationType()
at Sitecore.Update.Update.Serialization.SerializerFactory.GetSerializer()
at HedgehogDevelopment.SitecoreProject.PackageBuilder.PackageBuilder.GetSitecoreItemCommands(List1 cmds, BuildContext ctx, String projectFileFolder, Project sourceTDSProject, HashSet1 includedItems)
at HedgehogDevelopment.SitecoreProject.PackageBuilder.PackageBuilder.BuildPackage(BuildContext ctx)
at HedgehogDevelopment.SitecoreProject.PackageBuilder.Program.Main(String[] args)
C:\projects\SCBasics\SC-New\Sitecore\packages\HedgehogDevelopment.TDS.6.0.0.12\build\HedgehogDevelopment.TDS.targets(180,5): error : The package builder failed. Please set the build logging level to Normal or Detailed and see the build output log for more information on the failure.
We reached out to TDS Support team and they gave us new nuget package, which helped us resolve the issue. If you are starting your new project. I recommend you to use latest TDS version. This issue has been fixed in TDS 6.0.0.13
- “Exception Could not load file or assembly ‘System.Runtime, Version=4.2.2.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a’ or one of its dependencies. The system cannot find the file specified.(System.IO.FileNotFoundException):”
We got above error with TDS.6.0.0.14 with Sitecore 9.3
We reached out to TDS Support and this is what they replied:
This is likely caused by mixing the assemblies from .net core and standard in your package references. TDS doesn’t know which assemblies to use. The simplest way out of this is to create a folder relative to the solution root that contains just the assemblies needed by packaging and point the “Sitecore Assembly Path” value at that folder.
Please make sure to put the specific versions of the assemblies into that folder that are distributed with Sitecore. The best thing to do is to get them from the /bin folder in the Sitecore distribution. The assemblies you will likely need are:Sitecore.Kernel
Sitecore.Update
Sitecore.Log
Sitecore.Zip
Microsoft.Extensions.DependencyInjection.Abstractions
Microsoft.Extensions.Logging.AbstractionsIf you need more than this, the update package step will warn you and you can get them from the /bin folder.
After correcting our nuget references to use standard package reference and NOT .net core helped us fix the issue, Apart from that we also had to make sure that we use 2.1.1 version of Microsoft.Extensions.Options nuget package.
That’s it, Happy TDS Deployment! 🙂
Challenge:
Recently have been doing SXA GAP analysis for new project. Sitecore documentation team has done great job documenting those here : https://doc.sitecore.com/users/sxa/93/sitecore-experience-accelerator/en/the-sxa-renderings-and-rendering-variants.html
As you can see there are 70+ components and it’s easy to remember all of them (you no need to in real world). But when you are doing quick analysis and try to map Non SXA component with SXA.
Mark and SXA team has done great job help you visualize all components using this SXA Style guide : https://www.markvanaalst.com/blog/sxa-styleguide/introducing-the-sxa-styleguide/ (Thank you so much!)
Still I wanted to have list of all components as a single reference card. So, I can quickly review it. And that’s how idea of having SXA Renderings Cheat Sheet came into existence!
Solution:
You can view/Download PDF from here : https://cheatography.com/kpatil/cheat-sheets/sxa-renderings/
- First column indicates Rendering name
- Second column indicates whether it supports rendering variant or not (If this column doesn’t exist means it doesn’t support rendering variant)
- Third column indicates Description
Happy SXA Development! 🙂
Challenge:
Howdy Friends, I’m really excited to share my first SXA post with you!
SXA 1.0 was launched in 2016 and SXA 9.3 (Yes, Sitecore has changed SXA versioning!) has been released on November 2019.
I just explored little bit when it was launched, But I had my own apprehensions about It’s adoption due to unclear Sitecore licensing process [at-least to me] and lot of other things. But as following quote says:
“All change is hard at first, messy in the middle, and so gorgeous at the end.” – Robin Sharma.
I think this is true for SXA as well. SXA 9.3 is gorgeous version! [That doesn’t mean past version has been hard/messy 😉 ]
I wanted to learn SXA, But there were lot of resources on the web posted by great people. As a newbie, I was confused. From where to start? [You as well!?]
Or, If you have following questions in your mind, then this post is for you!
- Where to learn SXA basics?
- What is SXA?
- Why I should learn and adopt SXA?
- How can I be expert in SXA?
- What is co-relation between Sitecore Custom, Sitecore SXA, and Sitecore JSS? Are they competing development methodologies or complementing each other?
- We are starting new project — It should be on SXA or Custom?
- How SXA development is different than my earlier Sitecore Custom Development (Sitecore WebForms/MVC Development)?
- I’m working on Sitecore since long time, So, whatever I’ve learnt on Sitecore platform till this point of time will be of no use?
- Our FED-BED integration process will be impacted by SXA?
- All my FED team need to learn SXA?
- All my FED team need to have Sitecore instance in local?
- BED Developer Can’t I work ahead of FED Developers?
Wow, There are lot of questions. I might not be able to cover all of them in this post. But I will try to share SXA fundamentals and try to answer few questions and by end of this post my goal will be that you will be self sufficient to find your own answers!
Quotable Quote:
“Give a man a fish and you feed him for a day. Teach him how to fish and you feed him for a lifetime
Solution:
Let’s follow the W-W-H (What, Why, How) learning framework for SXA.
What is SXA?
Let’s refer Sitecore’s definition : https://doc.sitecore.com/users/sxa/93/sitecore-experience-accelerator/en/introducing-sitecore-experience-accelerator.html
Web development teams use Sitecore Experience Accelerator (SXA) to speed up the production of websites and to reuse components, layouts, and templates across a variety of sites.
SXA separates structure from design, so front-end designers, creative designers, content authors, and developers can work in parallel and you can deploy and maintain multiple sites quickly and cost effectively. Once a basic user experience plan is in place, everyone can get started on the platform. For example: the content author can start entering the content in the wireframe environment, while the front-end developer works on the theme, and the developer sets up the data templates.
Before we go in further details about SXA. Let’s understand type of Sitecore Development:
- Custom : If you have been doing Sitecore Development since long time, then you must have seen Sitecore framework ivolved from XSLT [You are getting old? :-)], to Web Forms and MVC. We’ve taken a big leap in development from XSLT to MVC for sure. But as a human we always want to do better than yesterday. Sitecore industry folks also wanted to make product better for the full eco system. Developers across different companies/projects/agencies have been spending more time on building those similar components – Header, Footer, Menu etc. rather than focusing on core business challenges and this was impacting “Time to market” for business. Everyone was looking for something better and there were few accelerators built by few companies for either their in-house use or as a product. But Configide‘s Zengarden was promising. It got adopted by lot of companies and community members. Sitecore also noticed that and adopted SXA in Sitecore’s offerings!
- SXA : SXA stands for Sitecore Experience Accelerator. As name suggests, it helps you to speed up your website development. SXA comes with over fifty components that can be completely customized for the needs of your brand.
- Sitecore JSS : For headless development.
Refer following diagram which depicts SXA benefits :
Let’s try to understand above diagram with an example – Company Contoso Inc. acquired new brand and would like to spin up a new website. They asked two different teams to develop website using different approaches. Sitecore Custom vs Sitecore SXA.
This is how overall process looks like:
As you rightly guessed, SXA team could spin up new website faster than Custom Development team.
ALERT! — If your Maths is good and you are a business stakeholder, Then please don’t create formula that SXA site should take 5 times less than Custom Development approach. It might not work that way. As each Site has different features, integrations and complexity. Please let your implementation team come up with proposed solution and time it needs to build. You also need to consider some learning curve for this new tool set. But relatively SXA should take less time than Custom. But how much that all depends on lot of factors. Which your implementation team will be able to share with you.
Also, depends on your site’s complexity, you might need to divide some work between Design, FED and BED team.
If you want to read more about SXA, I strongly recommend you to read this doc : https://doc.sitecore.com/users/sxa/93/sitecore-experience-accelerator/en/introducing-sitecore-experience-accelerator.html
As you might have noticed from architecture diagram. Lot of other Sitecore pieces are old e.g. MVC, WFFM, Presentation etc. You must have noticed Sitecore Powershell module in architecture diagram.
Powershell module is heart of SXA.
Why SXA?
I believe by this time you might have already been clear with “Why SXA?” and you must be saying “Why not SXA?” 🙂 But still if you are someone who needs more reasons before deciding. I would recommend you to read following posts:
- https://www.sitecore.com/products/experience-manager/editing-experience
- https://www.matthewdresser.com/sitecore/sxa-for-dummies
- https://www.switchit.com/blog/sitecore/sitecore-sxa-by-switch-gold-implementation-partner.aspx
If you reached thus far and have heard following feedback from your colleagues/friends about SXA and hesitant to use SXA with that feedback or not:
- Front-end and Back-end integration is challenging.
- It’s cumbersome to make rendering variants.
- Front-end markups can’t be exactly applied in Back-end.
- Export and Import process of Creative exchange is cumbersome when project is complex and team is big.
- It’s good for small sites. But if Site has complex custom design. Then customization takes lot of time.
This all is great feedback and learnings. Sitecore product team have been listening and working on it, and came up with SXA 9.3 version. Which has major updates. Two of my favorites are:
- Scriban templates support – This is huge and solves two main challenges – FED-BED integration and makes customization super simple and extensible!
- Front-end and Back-end integration workflow has been revamped : Raw FED Assets has been moved to file system rather than media library. So, your FED team mates can work in isolation and larger team can work together. Only compiled assets will be stored in Sitecore media library.
I will not spend much time writing about SXA 9.3 as lot of great souls have already written/shared about it:
- http://www.pieterbrinkman.com/2019/12/04/sitecore-9-3-sitecore-experience-accelerator-sxa-whats-new/
- https://www.markvanaalst.com/blog/sxa/sxa-9-3-the-new-frontend-developer-workflow/
- https://www.youtube.com/watch?v=ub-7gsC8T6U&t=9s
- https://www.youtube.com/watch?v=MDWuqhmvwgI
- Scriban
What!? You are still not convinced to use SXA and need to see more reasons to use SXA over Custom Development?
Let me share few examples using which you can compare Custom and SXA way to do things and understand how efficient SXA is:
- SXA Caching Options : Read this section : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/set-sxa-caching-options.html – Allows you to apply HTML Caching at Site, Component, Placeholder level along with donut caching.
- Source field report OOTB : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/run-a-source-field-report-to-set-the-data-source-context.html
- Helps you choose option : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/flowchart-to-determine-whether-to-create-a-custom-rendering.html
- Easy cloning : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/clone-an-sxa-site.html – You can create pattern library and clone it as per your need.
- SXA Site manager : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/manage-multiple-sites-with-the-sxa-site-manager.html – No more restarts for adding/deleting website!
- Standard Security and roles management : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/security.html
Hopefully you must have been convinced to use SXA by this time. If not, then please drop your use case and we can try to understand more about it :-). It might be possible that custom development might be more efficient for you to use than SXA.
Please remember technology and tools can’t solve all problems!
How to use SXA?
If you reached thus far. Then it means you are all charged up to learn SXA and looking for sources from where you can start learning basics of SXA.
I will share my learning sources and approach which I followed. Feel free to tweak it as per your need.
- Sitecore e-learning courses : I was very impressed with Sitecore training course’s new design. If you are developer, you might not find lot of value from Development Point of view. But these courses are great to have SXA’s fundamental understanding. You can follow your suitable approach to learn SXA. I learnt following two courses:
- Introduction to Sitecore® Experience Accelerator 9
- Fast-Track Design in Sitecore® Experience Accelerator 9
- Short, unofficial, ad-hoc, Sitecore SXA tutorials : This is second great source to learn SXA. Lot of great videos have been posted here. But please don’t get overwhelmed with all videos. To learn SXA, you no need to go through all videos. To keep things simple, go through some basic videos – especially – How to create site, Page Design, Partial design, Rendering variants etc. : https://www.youtube.com/channel/UCn_P819AlbNv_maQCqrKp4g/videos
- Sitecore Documentation : https://doc.sitecore.com/developers/sxa/93/sitecore-experience-accelerator/en/setting-up-and-configuring.html – This is another great source to learn more about SXA features. I would really like to shout-out documentation team for doing great job in documenting SXA as well as some of the recent document updates have been really great! – Looks like, Sitecore documentation team is going in right direction.
- Practice, Practice, Practice : Nothing can beat this step. You must need to do hands-on with SXA concepts. As there are lot of concepts to explore and you can’t remember those, until you practice.
- Install SXA : If you are using Sitecore Install Assistant then installing SXA is super easy.
- Create one website : Create one simple website, which has header, footer and some pages.
- Create new theme using SXA CLI and try to create few rendering variants with or without Scriban
- If you have been working with Sitecore Custom Development since long time, and have been aware about some best practices like Standard values, Renderings, Layouts etc. try to understand their Sitecore SXA approaches.
- Advanced learnings:
- https://buoctrenmay.com/2019/12/23/sitecore-xp-9-3-0-and-sxa-9-3-0-demo-habitat-home-setup-guide/
- Build complex website using SXA 9.3 and Scriban templates.
Hope you found this post helpful, and will help you to quick start your SXA learning. If you learn something new please blog and share with everyone!
Have a happy site building experience! 🙂
Good reads:
- https://www.the-reference.com/en-us/blog/mikecorrenti/2018/tips-for-working-with-sitecore-experience-accelerator
- https://tothecore.sk/2019/05/23/sitecore-sxa-1-8-documentation-for-ereaders/
Image credits:
Challenge:
SEO is critical for any website and it becomes critical to have redirect strategy for migration projects. We have been involved in lot of migration projects. Where clients either migrate from their legacy platform to Sitecore with new URLs or from old Sitecore platform to new Sitecore platform with new UX and design.
Defining redirect strategy has been key factor in success of these migration projects. Now, with each Sitecore version and variant. There are lot options available. You might get confused which strategy should be implemented.
We learnt something during my recent migration project and thought to share those with you.
Solution:
Thought to create flow diagram, which can help you understand this easily:
I won’t try explaining each step, as it should be self-explanatory. If not, feel free to comment on this post. And will try to get an answer for you.
In this post, For your ease. Will provide links to few of the modules/approaches listed above:
- Good post : https://blog.baslijten.com/another-look-at-url-redirects-in-sitecore/
- Marketplace modules:
- Url Rewrite Module by Andy Cohen : Few good posts already discussed about this topic
- Few other options : https://marketplace.sitecore.net/SearchResults#qr=Redirect
- IIS Url Rewrite : The Microsoft URL Rewrite module is an ISS extension that allows you to rewrite one URL to another using regular expressions.
- SXA Redirect OOTB support :
Hope you have smooth migration!
Challenge:
If your Sitecore app is on Azure and you are overwhelmed with Application Insights and need simple tool to check logs. AzureTools.aspx is an answer for that. You can find more about it from here: https://kb.sitecore.net/articles/911837
I’ve been big fan of this tool and Sitecore has been updating it regularly – https://sitecore.app.box.com/s/5f57l7fxk2zujriizzzs500k4qw91oyd
Recently I was trying to use it on my local 9.3 instance, but it was not working. When I deployed same aspx page on 9.0.2 solution it worked.
I spent lot of my time troubleshooting and finally was able to figure out. If you are facing similar issue or going to give a go to this tool soon. Then this post is for you only!
Solution:
Sitecore 9.3 OOTB comes with strict CSP rules. Read more here : https://kb.sitecore.net/articles/464569
Which is good and must be there for security reasons. But in local environment it might can block few of your developer tools.
Here’s what I did to fix my error:
- Opened Webroot\Web.Config
- Did – Find and comment this node – <add name=”Content-Security-Policy”
- AzureTools.aspx was up and running!
As I was focusing on analyzing and fixing my other issues and it was my Dev environment. Commenting this node was an okay solution. But I strongly recommend that you should it enabled and try to tweak your policy to fix URL specific issues or revert your changes once your Log analysis is done. Will dot it someday, or if you do it please blog.
Good reads:
- https://blog.baslijten.com/sitecore-security-3-prevent-xss-using-content-security-policy/
- https://report-uri.com/home/generate – last blog suggest this nice tool.
