{"id":57175,"date":"2023-04-27T16:03:33","date_gmt":"2023-04-27T10:33:33","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=57175"},"modified":"2024-06-10T15:39:09","modified_gmt":"2024-06-10T10:09:09","slug":"exploring-apache-sling-sitemap-generator-with-customization-in-aem","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/exploring-apache-sling-sitemap-generator-with-customization-in-aem\/","title":{"rendered":"Exploring Apache Sling Sitemap Generator With Customization in AEM"},"content":{"rendered":"

Prerequisite<\/b><\/h3>\n

\u00a0<\/span>AEM 6.5 installed with Service Pack 11+ or\u00a0 AEMaaCs SDK.<\/span><\/p>\n

What is Apache Sling Sitemap Generator
\n<\/b><\/h3>\n

As we all know, one crucial<\/span>\u00a0aspect of any website is its <\/span>Sitemap<\/b><\/em>, a file that provides a roadmap of all the pages of a website for search engines to crawl and index the website.<\/span><\/p>\n

Below is the sample sitemap.xml<\/strong><\/em> file:<\/span><\/p>\n

<\/p>\n

The Apache Sling Sitemap Generator<\/strong><\/em> uses Apache Sling<\/strong> to generate sitemaps dynamically based on the pages and content in an AEM website. This makes it easy for website owners to keep their sitemap up-to-date as they add, modify, or delete pages on their site.<\/span><\/p>\n

Setting up Apache Sling Sitemap Generator<\/b><\/h3>\n

Setting up the Apache Sling Sitemap Generator<\/strong> in AEM is a straightforward process that involves a few steps:<\/span><\/p>\n

    \n
  1. sling:sitemapRoot property
    \nThere are two approaches:
    \n<\/span>
    \n<\/span><\/b>\u00a0 \u00a0a)<\/strong> We need to paste this property on the page\u2019s <\/span>jcr:content node<\/b><\/em> on which we need to generate a sitemap.xml<\/strong><\/em> and its descendant’s children. It is the boolean property set to <\/span>TRUE<\/b><\/em>.
    \n<\/span>
    \n<\/span>\u00a0 \u00a0b)<\/strong> Go to Sites —-> your project—-> page(where you want to apply this property)—-> Properties option—->Advanced Tab and then check to “Generate Sitemap<\/em>“<\/strong> checkbox.<\/span><\/li>\n
  2. Sitemap Servlet Configuration (Note: This step is only required for custom page resource type<\/span>)\n

    Go to the<\/span> <\/b>http:\/\/<host>:<port>\/system\/console\/configMgr<\/em> and search for \u201c<\/span><\/b>SitemapServlet<\/em>\u201d configuration, and add the page resource type under property \u201c<\/span><\/b>sling.servlet.resourceTypes<\/em>\u201d.
    \n<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 <\/b><\/li>\n

  3. Apache Sling Sitemap \u2013 Scheduler configuration
    \nIt is the Out of the box configuration (OOTB<\/em><\/strong>) provided by <\/span><\/b>Apache Sling<\/em><\/strong> which generates the sitemap based on the cron expression under the path “<\/span><\/b>\/var\/sitemap<\/em>“ for those pages which have the “<\/span><\/b>sling:sitemapRoot<\/em>“ property as <\/span><\/b>TRUE<\/span><\/em>.<\/span><\/b><\/p>\n

    Below is the sample screenshot of the configuration:<\/p>\n

    <\/li>\n<\/ol>\n

    Required properties:<\/b>
    \n<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0a) <\/span>Name<\/b><\/em>: To provide any generic name to the sitemap.<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0b) <\/span>Schedule<\/b><\/em>: A cron expression used to run the sitemap generation job like this \u201c<\/span>0 0\/5 * * * ?<\/em>\u201d<\/b>.<\/span>
    \n<\/span>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0c) <\/span>Search Path<\/b><\/em>: This is the path from where the pages will be searched. We can change the path based on the requirement. By default, it is set to \u201c<\/span>\/content<\/b><\/em>\u201d.<\/span><\/p>\n

    \u00a0 \u00a0 \u00a0 \u00a0 The scheduler will run based on the cron expression and the sitemap.xml<\/em><\/strong> file will be generated. Go to http:\/\/<host>:<port><\/em><\/strong><\/span>\/crx\/de<\/em><\/strong> and search under this path \u201c<\/span>\/var\/sitemaps<\/b><\/em>\u201d\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 sitemap.xml<\/em><\/strong> will be present as shown below in the screenshot:
    \n<\/span>
    \n<\/span><\/p>\n

    \u00a0 \u00a0 \u00a0 \u00a0 We can access the sitemap by adding the sitemap.xml<\/em><\/strong> extension on the page for which we want to generate the sitemap like below\u00a0<\/span>http:\/\/<host>:<port>\/<page-url>.sitemap.xml.
    \n<\/strong><\/em>
    \n<\/span><\/p>\n

     <\/p>\n

    Sitemap Features<\/b><\/h3>\n

    We can use a few available sitemap features based on our requirements.<\/span>
    \n<\/span><\/p>\n

      \n
    1. Excluding Pages Based on Robot Tags
      \nGo to sites—-> your project—-> page(where you want to apply this property<\/em>)—> properties option—-> advanced tab and then apply <\/span>Robots Tags<\/em> value to \u201c<\/span>noindex<\/em>\u201d.The page on which the above property is set will be deleted from the sitemap. This approach is more useful in the case of individual pages.<\/p>\n

      <\/span><\/b><\/b><\/li>\n

    2. Changing Sitemap Storage Location
      \nWe can modify the path where the sitemaps are stored using the OOTB configuration\u00a0 “<\/span>Apache Sling Sitemap Storage Configuration”<\/em>. We need to create a new folder by following the same set of rules and permission as provided under \u201c<\/span>\/var\/sitemaps<\/em>\u201d.<\/span><\/b><\/b><\/b><\/b> <\/p>\n

      <\/li>\n<\/ol>\n

      Sitemap Customization
      \n<\/b><\/h3>\n

      Recently we experienced a unique use case while implementing Sitemap dynamically in AEM using the Apache Sling Sitemap Generator<\/strong><\/em> tool. <\/span>Here we will learn how to customize the OOTB generation of the sitemap based on the AEM website and business requirements. Some of the customization options are as follows:<\/span><\/p>\n

        \n
      1. Excluding Pages Based on Template Types
        \nExclude multiple pages from the sitemap based on the following key factors page template types, page published, etc, by overriding the <\/span>shouldInclude<\/em> method of\u00a0 <\/span>ResourceTreeSitemapGenerator<\/em> class. <\/span>In our use case, we excluded pages based on page template types for that, we created a Custom OSGI Configuration<\/em><\/strong> to exclude the custom template types.<\/span><\/b><\/p>\n

        Below is the screenshot of the Custom OSGI Configuration:<\/p>\n

        <\/b>\u00a0 \u00a0 <\/p>\n

        Below is the sample code to override the <\/span>shouldInclude<\/b><\/em> method:<\/span><\/p>\n

        <\/p>\n

        After this step go to <\/span>Apache Sling Sitemap \u2013 Scheduler configuration<\/strong><\/em> and add this above class name to the \u201c<\/span>includeGenerator<\/b><\/em>\u201d property.<\/span>
        \n<\/span>
        \n<\/li>\n

      2. Adding Custom Properties
        \n<\/b>We can add or remove custom properties like change frequency, priority, etc. by overriding the addResource<\/em> method from the same ResourceTreeSitemapGenerator <\/em>class.
        \nBelow is the sample code to override the addResource<\/em> method:<\/p>\n


        \n<\/span><\/h4>\n<\/li>\n
      3. Changing the Sitemap Format
        \n<\/b>The Apache Sling Sitemap Generator<\/em> supports both XML<\/em> and HTML<\/em> sitemap formats.
        \n
        \n<\/b><\/li>\n<\/ol>\n

        Now that you know how to configure and customize Apache Sling Sitemap Generator<\/strong><\/em>, you can use it according to your requirements and use cases. If you want to know more about the customization features, you can easily explore them.<\/span><\/p>\n

        <\/div>","protected":false},"excerpt":{"rendered":"

        Prerequisite \u00a0AEM 6.5 installed with Service Pack 11+ or\u00a0 AEMaaCs SDK. What is Apache Sling Sitemap Generator As we all know, one crucial\u00a0aspect of any website is its Sitemap, a file that provides a roadmap of all the pages of a website for search engines to crawl and index the website. Below is the sample […]<\/p>\n","protected":false},"author":1576,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":1264},"categories":[5868,446,1],"tags":[4847,4921,5194,1580],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57175"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1576"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=57175"}],"version-history":[{"count":4,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57175\/revisions"}],"predecessor-version":[{"id":57223,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57175\/revisions\/57223"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=57175"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=57175"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=57175"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}