Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Details

On the Details tab, you can update the knowledge base title, its visibility in portals, its status, and other options.

Before you begin

How to access

  1. Select Knowledge from the Service Manager menu item in the left-hand menu bar.
  2. Select Manage Knowledge from the navigation pane.
  3. Select the knowledge base.
  4. Select the Details tab.

Details tab

Available options

  • Id. The Knowledge Base (KB) number. Once created, the Id cannot be changed.
  • Default Language. The default language of the knowledge base (e.g. en-GB).
  • Name. The name of the knowledge base. This name will be displayed on the Browse view and visible to readers.
  • Icon. Select an icon for the knowledge base. This is most visible on the knowledge base cards on the Search/Browse View.
  • Description. Add a brief, helpful description of the knowledge base written with your audience in mind.
  • Status. The status of the knowledge base. Select from Active, In Development, or Retired. Only active knowledge bases will be visible to readers.
  • New Articles Require Approval. Use this toggle to require each new article to be approved before being published.
  • Use In Employee Portal. Use this toggle to make the knowledge base visible in the Employee Portal. This can ensure that the content is available for the correct audience. Setting this option to No will prevent the knowledge base from being available on the Employee Portal, also known as the Company Home.
  • Use In Customer Portal. Use this toggle to make the knowledge base visible in the Customer Portal. This can ensure that the content is available for the correct audience. Setting this option to No will prevent the knowledge base from being available on the Customer Portal.
  • Owned By. The owner of the knowledge base. Only users who have been assigned the Knowledge Manager role will be available as a knowledge base owner.
  • Last Modified By. The user who last modified these knowledge base details, for example, by switching the toggle to show the knowledge base in the Customer Portal.

Deleting a knowledge base

You can only delete a knowledge base if it doesn’t contain any articles. This is a safeguard to prevent the accidental deletion of multiple articles. Individual articles can be deleted or moved to a different knowledge base.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document