Who can use this feature?
- Available in the Client Portal Knowledge Base
- License Requirement: Enterprise, Project Manager, Technician, Team Member, or Student Technician
- Application Access:
- Specific Client Portal application containing the Knowledge Base
- For editing existing articles created by any user: Work Management
- Application-level Security Role: User's security role in the Client Portal must include:
- For editing only articles user is 'Owner' of: Edit Owned Articles
- For editing existing articles created by any user: Always Edit Articles and Add Articles
- View Knowledge Base
- Global Security Role: None required beyond basic Client Portal access (determined by license type)
The Knowledge Base allows you to create a draft version of any article, which can be revised and reviewed while the old version remains available. Drafts can be saved as many times as needed, allowing you to make changes over time.
In this article, we'll cover:
Drafts: The Knowledge Base maintains both a current published version of an article and allows for one draft version that exists alongside it. This draft can be worked on and saved to return to later. Once “Update Article” is clicked, the draft is closed and a new revision is created.
Revisions: Each time you finish an article draft (by clicking “Update Article”), the Knowledge Base creates a separate, historic version called a revision. Opening a revision allows you to see what was revised, who made the changes, compare two revisions, and restore a previous revision if necessary.
Example Draft to Revision Flow
- On a brand new article, there is only a Save button. This creates Revision 1.
- When you save, you are taken to the review page. If you are finished, you can click the Submit button on the right side.
- If you need to make further edits, click Edit Article.
- To continue working on the draft and save as needed, click Save as Draft.
- Once you've finished your draft and are ready to create a revision, click Update Article.
- This closes the Draft and creates Revision 2.
- Submit the article.
Once a draft is created, it is available in the Revisions list for the article.
To edit an existing article and create a draft:
- In the Client Portal, open the Knowledge Base, and navigate to the desired article.
- Click the Edit Article button.
- On the Content tab, make your changes to the article Body in the rich text editor.
- Add a summary of your changes in the Draft Summary field.
- Click Save Draft or Update Article.
Save Draft vs Update Article Buttons
Depending on your permissions, you have two options when saving an article.
- Save Draft button - All users who can create or edit articles can save the article as a draft.
- Update Article button - Users with the Review and Publish Drafts permission can also save changes directly to the article.
Save Draft Behavior
- Continues work-in-progress without creating a revision
- Updates or creates the draft for the article
- Does not change article status
- Does not affect the published/live version of the article
Update Article Behavior
- Creates a new revision
- Does not change article status
- If the article has previously been approved (Status=Approved), the changes will immediately be live
- If the article is brand new, the revision will still need to be submitted
To edit an existing draft:
- In the Client Portal, open the Knowledge Base, and navigate to the desired article.
- Open the article editor in one of two ways:
- Click the Edit Article button. Review the blue alert box above the article editor to ensure you are editing the draft.
- Or, click Edit Article, navigate to the Revisions tab, and click Draft to open the draft editor. In the draft details page, click Edit This Revision.
- Make your changes to the article content on the Content tab.
- Add a summary of your changes in the Draft Summary field.
- Click the Save Draft button to save the draft, or Update Article to create a new revision. If the article was already approved, it will publish immediately.
To delete a draft:
- In the Client Portal, open the Knowledge Base, and navigate to the desired article.
- Open the draft details in one of two ways:
- In the Details panel on the right, click on the Draft Status to open the draft details.
- Or, click Edit Article, navigate to the Revisions tab, and click Draft to open the draft details.
- In the draft details page, click Delete This Revision.
- Click OK to confirm deleting the revision.