Knowledge Base — Customer Portal — User Guide
Module: HSE (Health, Safety & Environment)
Audience: Customer contacts (client portal users)
Version: 1.0.0
Last updated: 2026-07-22
Overview
The HSE Knowledge Base (customer portal) is where logged-in contacts browse safety articles published by your organisation — policies, procedures, and guidance grouped by category (Health, Safety, Environment, and any custom groups).
This is separate from the main CRM Knowledge Base menu item (if shown in your portal). HSE articles live at a dedicated address beginning with /hse/kb.
Important: You must be logged in as a contact to use the HSE Knowledge Base. If you are not logged in, you will be redirected to the login page and returned to the article you requested after signing in.
Prerequisites
| Requirement | Details |
|---|---|
| HSE module | Activated on your Synergy instance |
| Contact account | Active login in the customer portal |
| Published articles | At least one article that is not Internal and not Disabled (see admin guide) |
Staff members who open HSE KB links while logged into the admin area may see a preview warning — that view is for staff checking content, not the normal customer experience.
How to open the HSE Knowledge Base
There is typically no sidebar link to the HSE Knowledge Base in the customer portal. Use one of these:
- Direct link shared by your organisation (for example
https://your-domain/hse/kb) - Link from an email or document pointing to a specific article (
/hse/kb/article/...) - Preview link from an HSE administrator (from the article editor in the admin area)
If you use the generic Knowledge Base item in the portal menu, that opens the core CRM knowledge base, not HSE safety articles.
Browsing by category
- Log in to the customer portal as a contact.
- Go to
/hse/kb(or follow a link provided by your organisation).
Expected:
- A search bar labelled for HSE article search
- A list of categories (groups), each showing the number of articles
- Short description text under each category name
- Click a category name to see all articles in that group.
Expected:
- Article titles as links
- Published date beside each title
- Short excerpt (first part of the article text)
Searching articles
- On the HSE Knowledge Base home or category page, type your question or keywords in the search field.
- Click Search (or submit the form).
Expected:
- Page title indicates you are viewing search results
- Matching articles grouped under their category headings
- If nothing matches: a message that no articles were found
Search looks at article titles and body text.
Reading an article
- Click an article title from a category list or search results (or open a direct article link).
Expected:
- Full article title and rich-text content
- Search bar at the top (same as other KB pages)
- Related articles in a side column when other articles exist in the same category
- Question: Did you find this answer useful? with Yes and No buttons
- Optionally click Yes or No to send feedback.
Expected: A thank-you or rate-limit message appears below the buttons. You can only submit one vote per article per day from the same connection.
Note: If feedback does not appear to save, contact your administrator — a known integration issue may route feedback to the wrong endpoint until fixed.
What you will not see
| Content type | Visible to contacts? |
|---|---|
| Internal articles (staff-only) | No — not listed; links should not be shared with customers |
| Disabled articles | No — treated as unpublished |
| Empty categories | Hidden — categories with no public active articles do not appear |
Staff preview (for administrators testing content)
If a staff member opens /hse/kb while logged into the admin backend (without a contact session), the page may still load but shows a warning that the knowledge base is for logged-in contacts and they are viewing as staff for preview only.
In preview mode, internal articles may appear in lists — this is not what customers see. Always verify with a contact login before go-live.
Common issues
| Symptom | Likely cause | What to do |
|---|---|---|
| Redirected to login | Not signed in as a contact | Log in with your portal credentials |
| Page not found (404) | Wrong URL, disabled article, or bad slug | Check link; ask admin to confirm article is active |
| No articles listed | All articles internal/disabled or none created | Ask HSE admin to publish public articles |
| Category empty | No public articles in that group | Try another category or search |
| "Knowledge Base" menu shows different content | That menu is the core KB, not HSE | Use /hse/kb for HSE safety content |
| Cannot find HSE KB in menu | No automatic menu entry | Bookmark /hse/kb or request a link from admin |
| Feedback buttons do nothing useful | Technical routing issue | Report to administrator |
Related features
- KB Articles (admin) — how staff create and publish content: kb-articles.md
- KB Groups (admin) — how categories are managed (separate guide when available)
- Incident management — report workplace incidents: incident-management.md
Test execution sign-off (QA)
| Section | Description |
|---|---|
| 1 | Anonymous user redirected to login from /hse/kb |
| 2 | Contact login — category index loads with counts |
| 3 | Category drill-down — article list and excerpts |
| 4 | Search — results and empty state |
| 5 | Article page — body, related articles, view tracking |
| 6 | Feedback Yes/No — success and 24h duplicate block |
| 7 | Internal article hidden from contact listings |
| 8 | Disabled article returns 404 on direct URL |
| 9 | Staff preview — warning shown; internal visible in list |
| 10 | Confirm /hse/kb distinct from core knowledge-base |
Record Pass/Fail per section when executing QA.