Knowledge Base
This page is generated from the in-app guide content — edit
featureToggleGuidesand runpnpm gen:feature-toggle-docs.
AI article drafts
Let AI draft knowledge base articles. Drafts are saved unpublished for review.
| Code | Default | Switch at | Turn on first |
|---|---|---|---|
knowledge.ai_draft_article_enabled | On | /settings/others-configuration | — |
How it works
Checked every time an AI article draft is requested — from the “Draft with AI” button and from the knowledge gap agent action that drafts a missing article.
When ON
AI writes a draft article from a topic; the draft is saved unpublished for review. Each draft uses AI credits.
When OFF
The request is refused with “feature disabled”; the agent action is skipped and records the reason.
Screens, documents and reports affected
Knowledge Base → New article → Draft with AI; AI agent action “create knowledge base article draft”.
Caveats
A draft is never published by AI — publishing still follows the normal rules, including approval if required.
Allow public access
Allow the public/customer knowledge portal to show articles. An article appears there only when it is published, its access level is “public” and its category is marked public. Off: the portal shows nothing.
| Code | Default | Switch at | Turn on first |
|---|---|---|---|
knowledge.public_access_allowed | On | /knowledge/settings | — |
How it works
Read on every request to the public knowledge portal, separately for each company in the workspace.
When ON
The portal shows articles that are published, have access level “public” and sit in a category marked public.
When OFF
The portal shows nothing for that company (the portal address answers “not found” when no company allows it).
Screens, documents and reports affected
Public / customer knowledge portal; Knowledge Base → Settings → Public portal.
Caveats
Articles without a category never appear on the public portal. Turning the switch off hides articles immediately; nothing is deleted or changed on the articles.
Approval required to publish
Articles must be reviewed and approved before they can be published.
| Code | Default | Switch at | Turn on first |
|---|---|---|---|
knowledge.approval_required_for_publish | On | /documents/settings | — |
How it works
Checked whenever a Knowledge Base article is published: the Publish button, bulk publish and the AI agent action that publishes an article.
When ON
A draft cannot be published directly — the author submits it for review, and a reviewer approves it (the approval publishes it). Bulk publish is refused.
When OFF
Anyone who can edit an article can publish a draft or a reviewed article directly, one by one or in bulk.
Screens, documents and reports affected
Knowledge Base → article page (Publish, Submit for review, Approve), article list bulk actions, AI agent publish actions.
Caveats
Applies to Knowledge Base articles only; publishing a Documents file to recipients has its own switch (documents.approval_required_for_publish). Turning it on does not unpublish articles that are already published.
Comment moderation
New comments require moderation before they appear.
| Code | Default | Switch at | Turn on first |
|---|---|---|---|
knowledge.comment_moderation | Off | /knowledge/settings | — |
How it works
Checked when a comment is posted on a Knowledge Base article.
When ON
New comments are saved as “pending” and are hidden from readers until a moderator approves them; the author is told the comment awaits review.
When OFF
New comments are approved and visible immediately.
Screens, documents and reports affected
Knowledge Base → article comments, comment moderation queue.
Caveats
Only affects comments posted after the change: turning it off does not approve comments already pending — moderate them from the queue.
Employees can ask AI
Let people without knowledge base editing rights ask AI questions answered from published articles (Knowledge Base and Employee Service → Help & Knowledge). Each question uses AI credits. Editors can always ask.
| Code | Default | Switch at | Turn on first |
|---|---|---|---|
knowledge.employee_ai_ask_enabled | Off | /knowledge/settings | — |
How it works
Checked each time someone asks the Knowledge Base AI a question, and when the page decides whether to show the Ask box.
When ON
Everyone who can read the Knowledge Base can ask AI; answers come only from published articles and each question uses AI credits.
When OFF
Only knowledge base editors, reviewers and managers can ask; for other people the Ask box is hidden and the API refuses with “feature disabled”.
Screens, documents and reports affected
Knowledge Base → Ask AI; Employee Service → Help & Knowledge.
Caveats
Does not control XBuddy Chat — the chat assistant has its own AI access and can still search articles. Questions are logged for content-gap review.
Version history
Every edit that changes an article’s content saves the previous content as a version you can compare and restore. Off: edits overwrite with no history.
| Code | Default | Switch at | Turn on first |
|---|---|---|---|
knowledge.version_control | On | /knowledge/settings | — |
How it works
Checked each time an article is saved, and when someone restores an older version.
When ON
Before an edit that changes the article body is saved, the previous title, body, excerpt and settings are stored as a numbered version that can be compared and restored.
When OFF
Edits overwrite the article with no snapshot, and restoring an older version is refused (it would overwrite without a way back).
Screens, documents and reports affected
Knowledge Base → article editor, Version history panel (compare, restore).
Caveats
Only edits that change the body create a version — a title-only change does not. Versions saved earlier stay and can be viewed after turning it off, but cannot be restored until it is on again.