Need sample Sitecore PowerShell script to add components to any SXA page dynamically

Question

We are looking for a Sitecore PowerShell script using which we can assemble/add components directly to an SXA page. I am able to add an SXA page, then add a Container component (under the page structure) to the page. But now I am not able to understand how to add any component under this Container Component via the same script.

$newSitecorePageItem = New-Item -Path $($rootItem.ItemPath) -Name "Demo 1" -ItemType "/sitecore/templates/Project/Website/Page"

$renderingPath = "/sitecore/layout/Renderings/Feature/Experience Accelerator/Page Structure/Container"

$renderingItem = Get-Item -Database "master" -Path $renderingPath | New-Rendering -Placeholder "main"

Add-Rendering -Item $newSitecorePageItem -PlaceHolder "main" -Instance $renderingItem -Parameter @{ "Reset Caching Options" = "1" } -FinalLayout:$useFinalLayout

Now suppose I want to add a Splitter Row inside this container and then further add other components into individual rows of Splitter Row i.e Component A to row1 and Component B to row2. What placeholder should I write for these components? Please suggest.

Thanks & Many Regards, Lalit Joshi

Answer 1

First you need to understand how dynamic placeholders are generated in SXA.

To learn about it open any view with rendering supporting dynamic placeholders: Views\Container\Container.cshtml

You will notice that placeholder key has following format:

const string placeholderKeyPrefix = "container";
var key = string.Format("{0}-{1}", placeholderKeyPrefix, Model.Id);

Which can generate following placeholders: container-1, container-2

Value for Model.Id is taken from rendering parameters (param: DynamicPlaceholderId). This parameters is autogenerated when you drop a rendering on a page. It will start with value 1 or more if there is already rendering of the same type with the same index in rendering parameters.

Now, in your case when you add rendering using this line:

Add-Rendering -Item $newSitecorePageItem -PlaceHolder "main" -Instance $renderingItem -Parameter @{ "Reset Caching Options" = "1" } -FinalLayout:$useFinalLayout

you have to add DynamicPlaceholderId manually.

You have to do it because you specified parameters explicitly. If you will leave it empty SXA will autogenerate DynamicPlaceholderId (and defaults for other parameters) for you - but then you have to fetch it anyway because you cannot be sure what's the index used in placeholder.

p.s. I am not sure why you are trying to do it this way. Can you describe the challenge you are trying to address? Maybe there are other better ways of solving it.?