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.

始める前に

Role required: admin

このタスクについて

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.

注:

The metatags will be added to the Knowledge Article View [kb_article_view] only when viewed by the user agents mentioned in glide.knowman.serviceportal.seo_user_agent system property. 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.

手順

1. Navigate to All > 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?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">']
   Return a SEO optimized HTML content for SEO bots	Modify the generateSEOTags function to return the SEO optimized HTML content in items.customSEOHTML.

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

5. Click Update.