SEO for canonical URLs and localized versions of knowledge articles

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of SEO for Canonical URLs and Localized Versions of Knowledge Articles

    This guide provides essential information on enhancing the searchability of ServiceNow knowledge articles through the implementation of canonical URLs and hreflang tags for localized versions. By enabling these features, you can ensure that search engines effectively index your articles and present the correct language versions to users.

    Show full answer Show less

    Key Features

    • SEO Script Checkbox: Select the "Use SEO script" checkbox on the Knowledge Article View page to automatically add canonical and hreflang tags.
    • Canonical URLs: Automatically generates a canonical URL for each knowledge article, ensuring search engines recognize the primary version. Example format: https://.servicenow-com/csp?id=kbarticleview&sysparmarticle=
      .
    • Hreflang Tags: Adds hreflang tags for translated articles, helping search engines serve the appropriate language version. Example: <link rel="alternate" href="https://.servicenow-com/csp/fr?id=kbarticleview&sysparmarticle=
      " hreflang="fr" />
      .
    • Self-referencing Hreflang Tags: Includes a self-referencing hreflang tag for the current language version of the article.

    Key Outcomes

    By implementing these SEO enhancements, ServiceNow customers can expect improved visibility of knowledge articles in search engine results and better user experience through accurately localized content. This is particularly important for organizations that engage with a global audience, as it ensures that users receive relevant information in their preferred language.

    Improve the searchability of knowledge articles by adding tags for canonical URLs and hreflang tags for translated knowledge articles.

    You can add the default tags for canonical URLs and hreflang tags by selecting the Use SEO script check box on the Knowledge Article View [kb_article_view] page record. For more information, see Enable SEO for canonical URLs and localized versions of a portal page.

    When the Use SEO script option is selected:

    • The canonical URLs for a knowledge article are added to the knowledge article view page.

      Example canonical URL: https://<instance name>.servicenow-com/csp?id=kb_article_view&sysparm_article=<article number>

    • The hreflang tags for the translated versions of a knowledge article are added to the knowledge article view page.

      Example URL with an hreflang tag: <link rel=“alternate” href=“https://<instance name>.servicenow-com/csp/fr?id=kb_article_view&sysparm_article=<article number>” hreflang=“fr”/>

      Note:
      A self-referencing hreflang URL is also added for the language of current knowledge article.

      For example, an English knowledge article is viewed by visiting a URL with the following format:

      https://<instance name>.servicenow-com/csp/?id=kb_article_view&sys_kb_id=<sys_id>

      In addition to the hreflang tags added for translations, the English language self-referencing hreflang tag is added:

      <link rel=“alternate” href=“https://<instance name>.servicenow-com/csp/?id=kb_article_view&sys_kb_id=<sys_id>” hreflang=“en”/>

    Script includes for canonical URLs and hreflang tags

    By default, the knowledge article view page uses the SPSEOHeaderTagsArticleViewSNC script include to add the SEO tags for canonical URLs and hreflang tags.

    The following table describes the script includes for adding canonical URLs and hreflang tags to Service Portal pages, including the knowledge article view page.
    Table 1. Script includes for canonical URLs and hreflang tags
    Script include Description
    SPSEOHeaderTagsSNC Includes the default implementation for the canonical URLs and hreflang tags for Service Portal pages.

    This script include is read-only.

    For more information, see Enable SEO for canonical URLs and localized versions of a portal page.
    SPSEOHeaderTags Facilitates overriding the default implementation in the SPSEOHeaderTagsSNC script include for Service Portal pages.

    The SPSEOHeaderTags script include extends the  SPSEOHeaderTagsSNC script include.
     SPSEOHeaderTagsArticleViewSNC Overrides the generateHrefLangArray and generateCanonicalURL functions for the knowledge article view page configured in the SPSEOHeaderTags script include.

    The SPSEOHeaderTagsArticleViewSNC script include is read-only and extends the   SPSEOHeaderTags script include.
    SPSEOHeaderTagsArticleView Facilitates overriding the default implementation in the SPSEOHeaderTagsArticleViewSNC script include for the knowledge article view page.

    The SPSEOHeaderTagsArticleView extends the  SPSEOHeaderTagsArticleViewSNC script include.

    As an administrator, you can add canonical URLs, hreflang tags, and any custom headers for knowledge articles by updating the SPSEOHeaderTagsArticleView script include. For more information, see Configure custom SEO tags for canonical URLs and localized knowledge articles.