Knowledge Management Components

This topic lists and describes knowledge management components.

The following table describes components specific to knowledge management components.

Component Name

Description

Knowledge Article

Enables you to display a knowledge article when the component's variable kmContentId is configured with a valid Knowledge Article ID.

Knowledge Article List

Displays a list of knowledge articles associated with a supplied search term and optionally selected product and category filters.

Knowledge Popular Articles List

Displays Popular Knowledge Articles. This component provides a user interface component that displays popular articles that are measured by a ranking score. This ranking score is derived from the strength of the knowledge article viewed within a time lapse mechanism.

The following variables are associated with this component:

  • kmPopularArticlesList - The Service Data Provider for the component which maps the Service Data Provider to the following custom fetch action chain: kmPopularArticlesFetchAction.

  • kmPopularArticlesFilter - The product category filter that adds context to the query. The Action chain associated with the Popular Articles Fetch has a description with details on how kmPopularArticlesFetchAction can be used. kmPopularArticlesFetchAction queries the most popular items back from the Knowledge Management content REST API. The number of results can be limited by updating the kmPopularArticlesLimit NUMBER page variable.

  • kmPopularArticlesLimit - Controls the maximum number of articles to display. The default value is 5.

  • kmPopularArticlesResultsCache - Represents the object used to scope the caching of the popular articles, and prevents an article from being called more frequently than appropriate.

Knowledge Search

Displays a list of knowledge articles associated with a supplied search term and optionally selected product and category filters. This component can used in collaboration with the Knowledge Article List and Knowledge Article Facets components.

Knowledge Article Facets

Enables you to filter a list of knowledge articles resulting from a knowledge search. Types of facets include: Product, Category, Collection, and Document Type.