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

Approvals

Each knowledge base has a setting to enable approvals. When this is turned on, any contributor will have to submit a new article for approval before it can be published and visible to readers.

Tip

When approvals are turned on, the articles that are created by the knowledge base owner are excluded from the approval process.

Draft Articles

When a contributor creates a new article, the status is set to Draft. The contributor can edit and update the article. When the article is complete, the contributor can submit the article for approval. This triggers a notification to the knowledge base owner.

Approval Pending

The knowledge base owner has the option of either accepting or rejecting the article.

  • Reject. This resets the article to draft and notifies the article owner about the rejection. The article owner can then make edits and resubmit.
  • Accept. This allows the article to proceed and the status will be set to Published.
  • Cancel Approval. This resets the article to draft. This is useful if the article owner needs to make updates to the article after having submitted it for approval. The article owner can then make edits and resubmit.

Published

Approvals are only applicable to new articles. Once an article has been published, edits and updates can be tracked in the audit log.

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