Documentation

    {{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}}

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}}

Search Data

The Knowledge search data helps analyze what people are searching for. This can help provide insight into how to organize your knowledge and identify gaps.

Search Data

  • Date. The date/time that the search was run.
  • Search Term. The full search that was entered by the user.
  • Results. The number of articles that were returned in the search results.
  • Source. Where the search was initiated from.
  • Searched By. The user that performed the search.
  • User Type. Identifies whether the person performing the search is a basic user, full user, or contact.

A valuable aspect of search data is identifying instances of someone having searched for something without getting any results. Getting no results — or in some cases, too many results — can impact the usefulness of your Knowledge content. Using this data can continually help you improve your Knowledge content. Ask yourself:

  • Are there any articles covering what they are looking for?
  • Do existing articles contain the correct text for the articles?
  • Where are most of the searches coming from?
  • Is a search term trending on a particular day?

Use the filter to show searches that contain a particular word.

  • How many times has this word been included in a search?

Search Data Filter

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