Managing Knowledge Base Articles

Adding, editing, and managing Articles in the Knowledge Base

The Articles Dashboard is where you can view all current and historical Articles in your Knowledge Base. 

From the dashboard you can export your Articles as PDFs, create new Articles, as well as refresh your article list as needed.


💻

The Article Dashboard Explained

There are three major areas of the dashboard:

  1. Group and Role Filter - this is where filters can be applied based on specific Article Groups or Roles.
  2. Search Bar- Search your Article list with this text search.
  3. Article List - this is where your Articles are displayed.

Further details of each section are explained in following tabs.

 
 
 

Article Group

An Article can belong to a single Article Group within the Knowledge Base.


Add an Article Group

Click the Create New Group button from the Article Group menu.

Type the Group Name in the Details field.

Click Save Job Group to save.


 
 

Edit an Article Group

Click the Edit pencil next to the group you wish to edit.

Update the Details as needed and click Update Job Group to save your changes.


 
 

Delete an Article Group

Click the Rubbish icon next to the group you wish to delete.

A confirmation window will appear - click OK to delete the Article Group.

 
 
 
 

Roles

Roles are created and managed in the Roles Catalogue.

Click Create Role and enter the name of the role.

Click the Save icon to save the newly created Role.

 
 

Search

Type into the Article Search bar to get a live-list based on your entered criteria.

Even as-little as a single character can be used in this search field. 

 
 

List

The Article list will display all Articles records that have been created.

 

Sorting of the columns is done by clicking on the arrow next to the column name. This will alternate between sorting Ascending and Descending sorts.

 
 

Managing Articles in the Knowledge Base

New

 

Click the Plus button to create a new Article.


When creating a new Article, the only required field is the Name.


An Article has the following options:

  • Article Group
  • Role
  • Position
  • Related Articles
  • Next Review Date
  • Article Number 

The content of the Article can be type or pasted into the HTML canvas below the Article Details.


You can Save as Draft or Publish the article immediately.

 

 
 

Edit

To Edit an Article, from the Article list, click on the Article Name.

Once you are viewing the Article, click the Edit pencil icon to change to Edit Mode.


When Editing an Article, you can keep it marked as a Draft or Publish the Article.

Once an Article is marked as published, it cannot be reverted to the Draft status.


Minor and Major Updates

When saving as a Draft or Publishing an Article after making changes, you will be presented the Revision screen.

From here, select the revision as either Minor or Major. 

 

A Minor revision will update the second digit of the Version number - ‘Version 1.3’.

A Major revision will update the first digit of the Version number - ‘Version 2’.

Actions and Files

While viewing an Article, but not in Edit Mode, you can create Article Actions or Linked Files by clicking the Plus icon in the top right corner.


Article Actions

Article Actions are Form-based activities related to the Knowledge Base Article

Each action has a Name, a Performed by Role, a Step Number, and Form Action.

An in-depth description of the related form activity can be provided in the HTML Canvas.


Linked Files

Articles can have Linked Files, providing additional context or supporting documentation for the Article.

When adding a Linked File, select a Folder as desired (but not required). 

Click the Upload button to attach the specific file desired.

Click Next to attach the file to the Article.

 
 
 
 

Delete

You can Delete an Article while in Edit Mode.

 

While in Edit Mode, click the Rubbish icon next to the Save as Draft or Publish buttons.