Sitecore Layout Service: Custom Rendering Contents Resolver

Sitecore’s Layout Service acts as a Headless endpoint, delivering requested pages or rendering data in the JSON format. This service can be accessed via GraphQL in both Sitecore Headless (JSS) within traditional Content Delivery and the Sitecore Experience Edge product. Rendering Content Resolvers complement the Layout Service by exposing or providing complex Sitecore Content of the rendering once more, this time in JSON Object format.

Sitecore Headless provides rendering contents resolvers and they are found here:

/sitecore/system/Modules/Layout Service/Rendering Contents Resolvers.

When you are working with the SXA then SXA related rendering content resolver are found here:

/sitecore/system/Modules/Layout Service/Rendering Contents Resolvers/SXA

and

/sitecore/system/Modules/Layout Service/Rendering Contents Resolvers/Headless Experience Accelerator

These default resolves are used full for majority of situations. But custom resolvers may be required.

Here is the simple process for creating custom content resolve.

Step 1: Creating custom class by inherit

Sitecore.LayoutService.ItemRendering.ContentsResolvers.RenderingContentsResolver and must override ResolveContents method of the base class.

Copy the below class:

Copy to Clipboard

using Newtonsoft.Json.Linq;

using Sitecore.Data;

using Sitecore.Data.Items;

using Sitecore.Diagnostics;

using Sitecore.LayoutService.Configuration;

using Sitecore.LayoutService.ItemRendering.ContentsResolvers;

using System;

using System.Collections.Generic;

using System.Linq;

namespace SourcevedJSS.Feature.Search.Extensions

{

public class RecommendedProductsContentsResolver : RenderingContentsResolver

{

private List items = new List();

public override object ResolveContents(Sitecore.Mvc.Presentation.Rendering rendering, IRenderingConfiguration renderingConfig)

{

Assert.ArgumentNotNull(rendering, nameof(rendering));

Assert.ArgumentNotNull(renderingConfig, nameof(renderingConfig));

Item ds = GetContextItem(rendering, renderingConfig);
            var recommendedItemsFieldId = Templates.Products.Fields.RecommendedItems;

if (ds.Fields.Contains(recommendedItemsFieldId) && !string.IsNullOrWhiteSpace(ds.Fields[recommendedItemsFieldId].Value))

{

List recItemIds = ds.Fields[recommendedItemsFieldId].Value.Split('|').ToList();

foreach (var id in recItemIds)

{

var item = Sitecore.Context.Database.GetItem(new ID(id));

items.Add(item);

}

if (!items.Any())

return null;

JObject jobject = new JObject()

{

["items"] = (JToken)new JArray()

};

List objList = items != null ? items.ToList() : null;

if (objList == null || objList.Count == 0)

return jobject;

jobject["items"] = ProcessItems(objList, rendering, renderingConfig);

return jobject;

}

Step 2 : Creating Resolver Sitecore item

Create Sitecore item under /sitecore/system/Modules/Layout Service/Rendering Contents Resolvers.

Now Content Resolver is Ready to Use. You can find this custom resolver in Rending Layout service section Select Rendering Contents Resolver.

Additional Links

Official Sitecore Layout Service Documentation
Custom Rendering Contents Resolvers in Sitecore
Related Sitecore Blogs

Sitecore

AI/ML

Sitecore Layout Service: Custom Rendering Contents Resolver

Step 1: Creating custom class by inherit

Step 2 : Creating Resolver Sitecore item

Additional Links

Related Posts

AI and Machine Learning in Sitecore XM Cloud

5 Ways to Use Sitecore AI for Personalization

How to Install Sitecore: Step-by-Step Guide for Beginners