Knowledge Base — Articles (Admin) — User Guide
Module: HSE (Health, Safety & Environment)
Audience: HSE content authors, administrators
Version: 1.0.0
Last updated: 2026-07-22
Overview
The HSE Knowledge Base lets authorised staff create and maintain safety articles — policies, procedures, guidelines, and similar content. Articles belong to groups (categories such as Health, Safety, Environment) and can be published to the customer portal or kept as internal staff-only references.
This guide covers admin article management (HSE → Knowledge Base). Managing groups and the customer portal are separate guides.
Prerequisites
| Role | Typical permissions |
|---|---|
| Administrator | Full HSE permissions + can manage KB groups |
| HSE content author | HSE → View, Create, Edit |
| View-only staff | HSE → View only (read articles in admin; cannot edit) |
Pre-use checklist:
- HSE module is activated
- At least one KB group exists (three defaults are seeded on install: Health, Safety, Environment)
- Staff account has HSE View permission (minimum)
Accessing the Knowledge Base (admin)
- Log in as a user with HSE access.
- Open HSE in the left sidebar.
- Click Knowledge Base.
Expected: The articles page opens with a list of all articles. Users without HSE permission see access denied.
Understanding the two views
The Knowledge Base admin page supports two layouts:
| View | How to open | Best for |
|---|---|---|
| List | Default on page load | Searching, filtering by group, bulk scanning |
| Kanban | Click the list/grid toggle button (top toolbar) | Visual organisation by group; drag-and-drop ordering |
List view
- Columns: Article name, Group, Active (check/cross icon), Date published
- Click the article name or Edit to open the editor
- Use the filter icon to show articles from a specific group only
Kanban view
- Each column represents a KB group (colour-coded header)
- Article cards show title, view count, and an Internal label when applicable
- Disabled articles appear with strikethrough (visible to editors only)
- Click an article title to edit (internal) or preview on the portal (public articles open in a new tab)
Creating an article
- On the Knowledge Base page, click + New article (requires Create permission).
- Complete the form:
- Subject (required) — article title
- Group (required) — select a category
- Internal article (optional) — check to keep the article staff-only (not shown on the customer portal)
- Disabled (optional) — check to hide the article from the portal and from view-only users
- Description — article body (rich text editor)
- Click Submit.
Expected:
- Success message and return to the Knowledge Base page
- New article appears in the selected group's list and kanban column
- A URL slug is generated automatically from the subject
Validation: Subject and Group are required. The form will not submit if either is blank.
Tip: To add a new group while creating an article, use the + button next to the Group dropdown. Note: Only administrators can create groups; other users must select an existing group.
Editing an article
- Open an article from the list or kanban view.
- Update fields as needed.
- On existing articles you can also edit the Slug (URL-friendly identifier used on the portal).
- Click Submit.
Expected:
- Success message and return to the Knowledge Base page
- Total views counter reflects portal visits (not admin previews)
- A link at the top shows the article URL (admin link for internal articles; portal link for public articles)
View-only users: Cannot save changes; submit button is hidden.
Internal vs public articles
| Setting | Customer portal | Admin link |
|---|---|---|
| Internal article checked | Not visible | Opens in admin editor |
| Internal article unchecked | Visible (when active) | Opens portal article page |
Use Internal for draft guidance, staff procedures, or content not meant for customers.
Disabling an article
Check Disabled on the article form to deactivate it.
Expected:
- Article hidden from the customer portal
- View-only staff no longer see it in kanban view
- Editors still see it in kanban with strikethrough styling
- Article remains in the list view with an inactive (cross) icon
To re-enable, uncheck Disabled and save.
Deleting an article
- From the list view, use the row Delete action, or open the article and click the trash icon (requires Delete permission).
- Confirm the deletion.
Expected: Article removed permanently from list and kanban. There is no recycle bin.
Reordering articles (kanban)
Users with Edit permission can drag article cards within a group column or between columns.
Expected:
- New order saved automatically
- Moving to another column changes the article's group
View-only users cannot drag cards.
Filtering articles by group
- In list view, click the filter icon in the toolbar.
- Select a group name (or View all).
Expected: Table shows only articles in that group.
Common issues
| Symptom | Likely cause | What to do |
|---|---|---|
| Knowledge Base not in sidebar | Module inactive or no view permission | Activate module; grant HSE View |
| Cannot add articles | Missing Create permission | Grant HSE Create |
| Cannot edit or reorder | Missing Edit permission | Grant HSE Edit |
| + next to Group does nothing / access denied | Not an administrator | Ask admin to create the group, or use HSE → Knowledge Base → KB Groups |
| Article not on customer portal | Internal or Disabled checked | Uncheck both; ensure article is active |
| Kanban shows no columns | No KB groups exist | Administrator creates groups first |
| Slug conflict | Duplicate URL slug | Edit slug to a unique value |
| View count is zero | No portal visits yet | Count updates when customers open the article |
Related features
- KB Groups — manage categories, colours, and order (administrators; separate guide)
- Customer portal — public-facing article browser at
/hse/kb(separate guide) - Incident management — unrelated workflow; see incident-management.md
Test execution sign-off (QA)
| Section | Description |
|---|---|
| 1 | Accessing Knowledge Base (admin) |
| 2 | List view — browse and filter |
| 3 | Kanban view — browse and toggle |
| 4 | Create article (public) |
| 5 | Create internal article |
| 6 | Edit article and slug |
| 7 | Disable and re-enable article |
| 8 | Delete article |
| 9 | Kanban reorder and cross-group move |
| 10 | Permission checks (view / create / edit / delete) |
Record Pass/Fail per section when executing QA.