Sitecore XMCloud Extending Layoutservice response using RenderingContentResolver

-

 We have different way to show the customize the layout service data

  • Rendering Content Resolver (For rendering level customization)
  • Layout service Context data (Applicable for context level in the Layoutservice response mostly used to share the static data to all components/pages etc)
  • Rendering's Integrated GraphQL
Steps to Customizing the LayoutService data using Rendering Content Resolver.
  • Clone the starter kit from github (https://github.com/sitecorelabs/xmcloud-foundation-head-staging) or create own visual studio solution by adding the reference to the following nuget packages.


  • Once reference added , create a Contentresolver class necessary to provide data to the rendering.
  • On build if receive any error related to the nuget package version like below
    •  

using Sitecore.LayoutService.Configuration; using Sitecore.LayoutService.ItemRendering.ContentsResolvers; using System; using System.Collections.Generic; using System.Linq; using System.Web; using Sitecore.Configuration; using System.Collections.Specialized; using Sitecore.Mvc.Presentation; namespace XmCloudSXAStarter.ContentResolver { public class UserDataContentsResolver : IRenderingContentsResolver { public bool IncludeServerUrlInMediaUrls { get; set; } public bool UseContextItem { get; set; } public string ItemSelectorQuery { get; set; } public NameValueCollection Parameters { get; set; } public object ResolveContents(Rendering rendering, IRenderingConfiguration renderingConfig) { //if you want to access the datasource item var datasource = !string.IsNullOrEmpty(rendering.DataSource) ? rendering.RenderingItem?.Database.GetItem(rendering.DataSource) : null; return new { //this returns the custom anonymous object with the results from datasource //also from customization( any custom sitecore api call or hardcorded , //any 3rd party rest api call to get data, etc) Name = $"Mr.{datasource.Fields["Title"].Value}", Description = datasource.Fields["Description"].Value //Blogs="" Data from sitecore api or from 3rd party rest etc }; } } }
  • Once code ready, publish this code to the running docker container, if we trying to access the content from local docker sitecore instance, or if trying to get the data from XMcloud directly push the code to github same repository from this XMCloud instance created, which will trigger the deployment to XMcloud with these updates.


  • Lets execute our GraphQL query.


  • Accessing the Layoutservice response in Nextjs application






Happy Programming 😊

Comments

Post a Comment

Popular posts from this blog

Custom Item Url and resolving the item in Sitecore - Buckets

-
Image
I have a situation to update the Item URL to be SEO friendly as my items in content tree looks like below. In the above image in order to resolve the item, Sitecore will find the item from the below URL http://domainname/en/dine/nv/chicken but I need to form a URL that is more SEO friendly like http://domainname/en/chicken In Sitecore by Out of box, we can achieve this by using Aliases , we can create an Aliases under System à Aliases and in the Linked Item field select the target item. But this is very tedious as we need to go to every item in the content tree and create Aliases, instead of that we will be going to do it programmatically using custom pipelines. ·          Link Provider (Provides the custom URL for the item based on the templates) ·          Item Resolver (Resolves the item based on the custom URL generated by CustomLinkProvider , that we going to create later...
Read more

Exploring Sitecore XM Cloud Forms: A Comprehensive Overview

-
Image
  The most awaited news came from Sitecore about the release of XM Cloud Forms.  Previously Sitecore enthusiasts / Marketers used different ways of forms implementation in Sitecore to reach the target customers like WFFM (Web Form For Marketers) Sitecore Forms Embeddable Forms Framework(EFF) XM Cloud Form is the latest addition by Sitecore and especially used to create Forms on XM Cloud pages. It will only work with the latest version of Sitecore JSS (21.6) Note:  I have tried to use XM Cloud Forms in my local docker setup by cloning the starter   repo , but I couldn't see the option of Forms in the XM Cloud dashboard to get started. Lets explore together on the features of Forms. Similar to Sitecore Components, we can navigate to  https://forms.sitecorecloud.io/  to start creating the Forms There are 2 important tabs in creating Sitecore Forms  Forms  Webhook(for triggering the submit action) We can create, modify, delete, and activate the f...
Read more

Sitecore Custom Rule (Action and Condition)

-
Image
I have a situation to create a custom Sitecore rule and action for it. v   Goto /Sitecore/system/Settings/Rules/Definitions/Elements v   Create a new item base on the template “ ElementFolder ” with a name “ Custom Rule ” v   Click on the item and create condition and Actions that are necessary for your requirements Condition Template Item: It has two important sections v   Data ·          Text (This is the condition Text which will use tokens to evaluate the condition and user input which will be in [ ] brackets.The brackets contain four positional parameters separated by commas (“,”). 1. The name of the property that the parameter sets in the .NET class that implements the condition. 2. The name of an item beneath the /Sitecore/System/Settings/Rules/Common/Macros item providing predefined functionality, or an empty string. For example, to activate a user interface allowing the user to select an item fr...
Read more