Skip to main content

Related Items not published in Sitecore Publishing Service

Sitecore Publishing Service (SPS) is an opt-in mechanism for high-performance publishing in large scale Sitecore setups. This module increases publishing throughput, reduces the amount of time spent publishing large volumes of items, and offers greater data consistency and reliability. The module also improves the user experience and provides better visual feedback to the user on the state of the publishing system. If you don't use SPS yet and if your publishing tasks take longer than expected, SPS module can be highly useful to you.

In this blog, I am going to share a recent experience related to configuring SPS in scaled environment. There is a specific step in installation guide which needs to be performed explicitly in scaled environments and if you miss it, you may have problems publishing related items with the page.

THE PROBLEM

In our case, publishing worked correctly but none of the related items of published page got published. We reached out to community on slack and also created a Sitecore support ticket to understand the possible root cause. We got answers but there was no proper explanation about what causes the problem and how the problem gets fixed. Hence, I decided to share it in this article.

THE SOLUTION

Publishing services seems to be dependent on Link database to find related items of the page being publishing. The default configuration for the Publishing Service specifies that the Links Database is stored in the Core database. Sitecore by default uses Core db for LinkDatabase for standalone instances but for CM or CD servers it uses Web database for LinkDatabase due to the Sitecore.Variables.config-

<?xml version="1.0" encoding="utf-8"?>

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:role="http://www.sitecore.net/xmlconfig/role/" xmlns:security="http://www.sitecore.net/xmlconfig/security/">

    <sitecore>

        <sc.variable name="defaultLinkDatabaseConnectionStringName" value="core"/>

        <sc.variable name="defaultLinkDatabaseConnectionStringName" role:require="ContentDelivery or ContentManagement">

            <patch:attribute name="value">web</patch:attribute>

        </sc.variable>

    </sitecore>

</configuration>

If you are running the Publishing Service in a scaled environment, then your Sitecore server's Links Data is stored in a different database than the Core database (as per config Web database). You must update the Publishing Service configuration accordingly. For example, if the Links Data is stored in the Web database, then the Publishing Service configuration needs the following override:

<DefaultConnectionFactory>

          <Options>

            <Connections>

              <Links>

                <Type>Sitecore.Framework.Publishing.Data.AdoNet.SqlDatabaseConnection, Sitecore.Framework.Publishing.Data</Type>

                <LifeTime>Transient</LifeTime>

                <Options>

                  <ConnectionString>Web</ConnectionString>

                  <DefaultCommandTimeout>120</DefaultCommandTimeout>

                  <Behaviours>

                    <backend>sql-backend-default</backend>

                    <api>sql-api-default</api>

                  </Behaviours>

                </Options>

              </Links>

If you are using SPS v5, this needs to be done in sc.publishing.xml. 

If our case, we were using SPS v6 due to which this change was done in multiple files as below -

  1. \sitecore\Sitecore.Framework.Plugin.Publishing\Config\sc.publishing.itemrevision.command.services.xml
  2. \sitecore\Sitecore.Framework.Plugin.Publishing\Config\sc.publishing.web.command.services.xml
  3. \sitecore\Sitecore.Framework.Plugin.Publishing\Config\sc.publishing.schema.command.services.xml

You must also update the database schema. To upgrade the database schema, run the following command:

Sitecore.Framework.Publishing.Host.exe schema upgrade --force

If you miss to perform these steps while configuring SPS in scaled environment, you may face issues in publishing. When you publish a page and check the checkbox for Publish Related Items, related items wont publish correctly and content authors will complain that their changes are not reflecting on live site.

This is also outlined by Sitecore support team in following link - 

https://support.sitecore.com/kb?id=kb_article_view&sysparm_article=KB0889655

Hope this helps you!


Labels:

Popular posts from this blog

Sitecore PowerShell Script to create all language versions for an item from en version

  We have lots of media items and our business wants to copy the data from en version of media item to all other language versions defined in System/Languages. This ensures that media is available in all the languages. So, we created the below powershell script to achieve the same -  #Get all language versions defined in System/Languages $languages = Get-ChildItem /sitecore/System/Languages -recurse | Select $_.name | Where-Object {$_.name -ne "en"} | Select Name #Ensuring correct items are updated by comparing the template ID  $items = Get-ChildItem -Path "/sitecore/media library/MyProjects" -Recurse | Where-Object {'<media item template id>' -contains $_.TemplateID} #Bulk update context to improve performance New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) { foreach($item in $items){    foreach($language in $languages){ $languageVersion = Get-Item -Path $item.Paths.Path -Language $language.Name #Check if language versi
Read more

Export Sitecore media library files to zip using SPE

If you ever require to export Sitecore media files to zip (may be to optimize them), SPE (Sitecore Powershell Extension) has probably the easiest way to do this for you. It's as easy as the below 3 steps -  1. Right click on your folder (icons folder in snap)>Click on Scripts> Click on Download 2. SPE will start zipping all the media files placed within this folder. 3. Once zipping is done, you will see the Download option in the next screen. Click Download Zip containing the media files within is available on your local machine. You can play around with the images now. Hope this helps!! Like and Share ;)
Read more

Make Sitecore instance faster using Roslyn Compiler

When we install the Sitecore instance on local, the first load is slow. After each code deploy also, it takes a while for the Sitecore instance to load and experience editor to come up. For us, the load time for Sitecore instance on local machines was around 4 minutes. We started looking for ways to minimize it and found that if we update our Web.config to use Roslyn compiler and include the relevant Nugets into the project, our load times will improve. We followed the simple steps - Go to the Project you wish to add the NuGet package and right click the project and click 'Manage NuGet Packages'. Make sure your 'Package Source' is set to nuget.org and go to the 'Browse' Tab and search Microsoft.CodeDom.Providers.DotNetCompilerPlatform. Install whichever version you desire, make sure you note which version you installed. You can learn more about it  here . After installation, deploy your project, make sure the Microsoft.CodeDom.Providers.DotNetCompilerPlatform.d
Read more

Experience of a first time Sitecore MVP

The Journey I have been working in Sitecore for almost 10 years now. When I was a beginner in Sitecore, I was highly impressed by the incredible community support. In fact, my initial Sitecore learning path was entirely based on community written blogs on Sitecore. During a discussion with my then technology lead Neeraj Gulia , he proposed the idea that I should start giving back to developer community whenever I get chance. Just like I have been helped by many developers via online blogs, stackoverflow etc., I should also try to help others. Fast forward a few years and I met  Nehemiah Jeyakumar  (now an MVP). He had a big archive of his technical notes in the form Sitecore blogs. I realized my first blog dont have to be perfect and it can be as simple as notes to a specific problem for reference in future. That's when I probably created my first blog post on Sitecore. At that time, I didn't knew about the Sitecore MVP program. Over the years, I gained more confidence to write
Read more

Clean Coding Principles in CSharp

A code shall be easy to read and understand. In this post, I am outlining basic principles  about clean coding after researching through expert recommended books, trainings and based on my experience. A common example to start with is a variable declaration like - int i  The above statement did not clarify the purpose of variable i. However,  the same variable can be declared as -  int pageNumber The moment we declared the variable as int pageNumber, our brain realized that the variable is going to store the value for number of pages. We have set the context in our brain now and it is ready to understand what the code is going to do next with these page numbers. This is one of the basic advantages of clean coding. Reasons for clean coding -  • Reading clean code is easier - Every code is revisited after certain amount of time either by the same or different developer who created it. In both the cases, if the code is unclean, its difficult to understand and update it. • To avoid s
Read more