Knowledge base fields and their behaviour
Field Label | Field Type | Field Behaviour | Purpose |
|---|---|---|---|
Name | String (Max Length: 255) |
| The way to identify a knowledge base from the others and used as its display value. |
Manager | Reference (User table) |
| The user who has special privileges for the knowledge base and is considered accountable for the content within it. The user here is expected to have the knowledge manager role and can skip workflow statuses and approvals when required based on their role and their name in this field. |
Publish Article Instantly | Boolean (Radio Button) | | Allows users to go from the workflow status of "Draft" to the status of "Published" and as a result, skip any approvals along the way. |
Role required for visibility | Multiple Reference (Role table) | | Controls the visibility of the knowledge base and any of the articles contained within. If this field is empty, anyone with the platform self service role can read articles in this knowledge base, otherwise if one or multiple roles are listed here, the user needs one of the roles listed in this field to be able to see the articles. |
Role required for editing | Multiple Reference (Role table) | | Controls who can edit the articles contained within a knowledge base. If it is empty, anyone with the knowledge editor role can edit draft / peer review articles in the knowledge base, otherwise the form will be read only. If one or multiple roles are listed here, the user needs one of the roles listed in this field to be able to edit the article. Note that they also need one of the roles required for visibility if one has been listed, otherwise they will not get visibility by default simply if they have one of the roles required for editing. |
Require approval for publishing | Boolean (Radio Button) |
| This flags whether an approval needs to occur for an article to be published. If this is false and publish article instantly is false, an article can go directly from the peer review status to the published status, as well as from the archived status to the published status. If it this field is true however, an article will need an approval to be published from the peer review status and an approval if it should be republished once archived. |
Require approval for archiving | Boolean (Radio Button) | | This flags whether an approval needs to occur for an article to be archived. If this is false, an article can go directly from published to archived without an approval. |
Approver | Reference (User table) |
| This is the list of users who will be asked for approval from an article has been asked for approval within a knowledge base (whether for publication or to be archived). Only one user from this list needs to approve for an article to be published or archived. |
Description | String (Max Length: 1000) | | This is a field on offer simply for informational purposes about a knowledge article and is not used for visibility, workflow or otherwise. |
Associated Articles | Mutliple Reference (Knowledge Article table) | | These are the articles that can be found within the knowledge base. |