You have to set the following configuration to true to get the detailed information on rendering parameters set.
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"> <sitecore> <settings> <setting name="LayoutService.DetailedRenderingParams" value="false"> <patch:attribute name="value">true</patch:attribute> </setting> </settings> </sitecore> </configuration>
By default this setting comes as false.If you are binding your component with the layout response but feel that if a custom property can come in the layout response and you could bind that in your component.
But as you know you can not insert the custom property in the layout response without heavy customisation but we have a way to do so.
We can achieve this on component level using useComponentProps and getStaticProps: GetStaticComponentProps methods in XM cloud.
Lets understand this quickly.
You have a component like follows:
In the component BlogIndexVariationOne we are passing the BlogIndexVariationOneProps. In this fields will be mapped from the layout response but rendering is worth to pay attention here that we will discuss the usage of it further in this blog.
Now assume that under this component you are returning the HTML with the data received in the fields object and additionaly you have a requirement to show the current page URL in any of the <div> tag also.
So as you know the current url will not work from window.location.href or writing the same in the useEffect() or even useLocation() won't work until you don't wrap your component in the <Router> tag.
So how can we get the current url then? Here we will use the getStaticProps: GetStaticComponentProps method as shown below:
export const getStaticProps: GetStaticComponentProps = async (
Here we are returning the requestPath provided by sitecore's context and it is returning the string type.
Now how will we use this in our component? Here comes the role of rendering that we passed in the component in the line const path = useComponentProps<string>(rendering?.uid);. So rendering?.uid in the useComponentProps tells the component that something is being passed from getStaticProps: GetStaticComponentProps as string return type so use that.
And voilla, now you can use the request path in your code.
So in place of context?.params?.requestPath you can use your any API fetch if you want it to be fetched using this although the best practice for getting the API data is to use in the useEffect() but this is also one more way to use.
Thanks!
We had one requirement to change the component's display on almost 1400 pages and doing so we had to follow following things:
1. Update the rendering parameters on the item
$parameters = [ordered]@{"DisplayContentInCard" = "1"; "ApplyBackground" = "1"; "AlignImageRight" = "1" }
$rendering | Set-RenderingParameter -Parameter $parameters | Set-Rendering -Item $pageItem -FinalLayout
2. Update the datasource item's field data.
3. Update the main page with one droplink field to be set with the specific item.
4. Export the info in the excel
Now the complete script is as follows:
Thanks!
I had a requirement to update the rendering parameter using the PowerShell script so here is the code below:
Screenshot - 1:
try { # rendering item id for which the parameters to be changed $renderingId = "{3F5DE058-F909-4813-B4AA-92F940FAE5DE}" # Item id on which rendering is available $itemId = "{E4A1AD6D-A6AD-47CE-8FF1-1783EE0082CA}" # Get item from master Database $item = Get-Item -Path "master:" -ID $itemId # This will be used to get the rendering info from Defaul layout as in Screenshot-1 $defaultLayout = Get-LayoutDevice "Default" # Get all the renderings on this item that are available on the Final Layout $renderings = Get-Rendering -Item $item -Device $defaultLayout -FinalLayout foreach ($rendering in $renderings) { # Check for our specific rendering if ($rendering.ItemId -eq $renderingId) { Write-Host $rendering.ItemId # Set the parameters in key value format, where DisplayContentInCard is the rendering parameter field name and 1 is the value because in my case this is checkbox so setting it as true # Same is for other rendering parameter fields ApplyBackground and AlignImageRight $parameters = [ordered]@{"DisplayContentInCard" = "1"; "ApplyBackground" = "1"; "AlignImageRight" = "1" } # Set the parameters value and update on item $rendering | Set-RenderingParameter -Parameter $parameters | Set-Rendering -Item $item -FinalLayout Write-Host "$($autoInsuranceItem.FullPath) - Item Id $($autoInsuranceItem.ID) - Rendering $($rendering.UniqueID) $DatasourceItemPath - $($rendering.Datasource)" } } } catch [System.Net.WebException], [System.IO.IOException] { $item }
You might have faced an error while making the container up using the up.ps1 script, and subsequently, when attempting to run docker compose down followed by docker compose up. This mostly happens when you make the containers up and then containers creates the network but you don't down them gracefully, or don't use down command before shutting down your system.
To resolve this problem, follow these steps:
1. Run docker network ls to show all the available networks.
Run docker network prune to remove all networks. Note: This command will delete all unused networks on your system.
3. Open command prompt and stop IIS by command iisreset /stop
4. Check in the services if there is any solr service using port 8984 (mostly in the docker-compose file this is the port used untill you did not change it) and stop that service.
5. Once the network deletion is complete, run docker compose up -d or ./up.ps1 to start the containers.
The issue should be resolved, and it should work fine.
6. If after 2nd point you get an error that endpoint is already is in use and unable to delete the network then down your containers -> init.ps1 -> up.ps1.
Reference: https://alvaropmontenegro.com/2024/05/31/sitecore-xm-cloud-local-setup-errors/
Thanks!
