Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home Orlando Now Platform Capabilities Now Platform capabilities Knowledge Management Configure Knowledge Management Configure the Knowledge Management Service Portal Configure custom SEO tags for canonical URLs and localized knowledge articles

    Configure custom SEO tags for canonical URLs and localized knowledge articles

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Configure custom SEO tags for canonical URLs and localized knowledge articles

    Discover relevant knowledge articles through search engines by adding custom SEO tags for canonical URLs and hreflang tags to the knowledge article view page.

    Before you begin

    Role required: admin

    About this task

    Update the SPSEOHeaderTagsArticleView script include to add canonical URLs and hreflang tags to the knowledge article view page. You can also add custom header tags to the knowledge article view page by implementing the generateCustomTagsForSEO function.
    Note: The tags are added to the Knowledge Article View [kb_article_view] page only when audience is set to public; that is, the page can be accessed without the need for authentication. For more information, see Create and edit a page using the Service Portal Designer.

    For information about the default behavior of canonical URLs and hreflang tags for the knowledge article view page, see SEO for canonical URLs and localized versions of knowledge articles.

    Procedure

    1. Navigate to System Definitions > Script Includes.
    2. Search for SPSEOHeaderTagsArticleView.
    3. In the Name column, click the SPSEOHeaderTagsArticleView link.
    4. On the Script Include form, modify the functions for knowledge articles.
      Functionality Implementation
      Return a canonical URL for a knowledge article Modify the generateCanonicalURL function to return the fully qualified canonical URL of a knowledge article as a string.

      For example, use the following URL format for a knowledge article in the customer service portal: "https://<instance name>.servicenow-com/csp?id=kb_article_view&sysparm_article=<article number>"

      Return an hreflang tag for translated versions of a knowledge article Modify the generateHrefLangArray function to return an hreflang array for the current language and the available translations for a knowledge article.

      For example, use the following format for a knowledge article translated in French in the customer service portal: [{locale:'fr', href: 'https://<instance name>.servicenow-com/csp/fr?id=kb_article_view&sysparm_article=<article number>'}]

      Return a custom header for a knowledge article Modify the generateCustomTagsForSEO function to return any custom header tags as an array of strings used for the knowledge article view page.

      For example, use the following format for a custom tag for a knowledge article: ['<meta custom-tag="" property="og:title" content="Service Portal">']

      For more information about configuring script includes, see Script includes.

    5. Click Update.

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Configure custom SEO tags for canonical URLs and localized knowledge articles

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Configure custom SEO tags for canonical URLs and localized knowledge articles

      Discover relevant knowledge articles through search engines by adding custom SEO tags for canonical URLs and hreflang tags to the knowledge article view page.

      Before you begin

      Role required: admin

      About this task

      Update the SPSEOHeaderTagsArticleView script include to add canonical URLs and hreflang tags to the knowledge article view page. You can also add custom header tags to the knowledge article view page by implementing the generateCustomTagsForSEO function.
      Note: The tags are added to the Knowledge Article View [kb_article_view] page only when audience is set to public; that is, the page can be accessed without the need for authentication. For more information, see Create and edit a page using the Service Portal Designer.

      For information about the default behavior of canonical URLs and hreflang tags for the knowledge article view page, see SEO for canonical URLs and localized versions of knowledge articles.

      Procedure

      1. Navigate to System Definitions > Script Includes.
      2. Search for SPSEOHeaderTagsArticleView.
      3. In the Name column, click the SPSEOHeaderTagsArticleView link.
      4. On the Script Include form, modify the functions for knowledge articles.
        Functionality Implementation
        Return a canonical URL for a knowledge article Modify the generateCanonicalURL function to return the fully qualified canonical URL of a knowledge article as a string.

        For example, use the following URL format for a knowledge article in the customer service portal: "https://<instance name>.servicenow-com/csp?id=kb_article_view&sysparm_article=<article number>"

        Return an hreflang tag for translated versions of a knowledge article Modify the generateHrefLangArray function to return an hreflang array for the current language and the available translations for a knowledge article.

        For example, use the following format for a knowledge article translated in French in the customer service portal: [{locale:'fr', href: 'https://<instance name>.servicenow-com/csp/fr?id=kb_article_view&sysparm_article=<article number>'}]

        Return a custom header for a knowledge article Modify the generateCustomTagsForSEO function to return any custom header tags as an array of strings used for the knowledge article view page.

        For example, use the following format for a custom tag for a knowledge article: ['<meta custom-tag="" property="og:title" content="Service Portal">']

        For more information about configuring script includes, see Script includes.

      5. Click Update.

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login