-
-
Notifications
You must be signed in to change notification settings - Fork 27
Groups of People Developer Guide
FreeITSM has several things called "group", and they are not the same thing. This page is the map: what each one is, which are groups of people at all, and which features accept which.
Read this before adding another one.
These are the only three things you can build once and point several features at.
| Table | Holds | Made in | Extra | |
|---|---|---|---|---|
| Team |
teams + analyst_teams
|
analysts | System β Teams | Carries module access, RBAC roles, department mapping, tenant reach |
| Learning group |
lms_learning_groups + lms_learning_group_members
|
analysts | LMS β Groups | Nothing else uses it |
| People group |
knowledge_user_groups + knowledge_user_group_members
|
analysts and portal users | Tickets β Users β Groups | Per-member expires_at
|
A team is not just a group. It is a permission-bearing object: team_modules grants module access, rbac_team_roles grants capabilities, department_teams decides which departments it sees, teams.can_access_all_tenants decides its company reach. Adding somebody to a team changes what they can do. That is why team management is administrator-only and lives in System.
A people group is the only one that can hold a portal user. member_type is 'analyst' or 'user', so it is the only grouping that spans both populations. See People Groups.
The
knowledge_prefix on the people-group tables is historical and must not be renamed β see People Groups Developer Guide.
This is the part that actually matters, and the part that is inconsistent.
| Consumer | Stored as | Accepts |
|---|---|---|
| Knowledge ACL | knowledge_acl.principal_type |
analyst Β· team Β· user Β· user_group
|
| LMS assignment | lms_course_assignments.target_type |
analyst Β· user Β· learning_group Β· user_group Β· all_users
|
| Module access |
analyst_modules / team_modules
|
analyst Β· team |
| RBAC roles |
rbac_analyst_roles / rbac_team_roles
|
analyst Β· team |
| Department visibility | department_teams |
team |
| Morning check routing |
morningChecks_Groups.AssignedTeamID / AssignedAnalystID
|
analyst Β· team |
- You cannot give a knowledge folder to a learning group.
- You cannot assign a course to a team.
Both are perfectly reasonable things to want, and neither is possible. Each consumer grew its own vocabulary at the time it was built, and nothing has since reconciled them.
π What to do about that is written up in Consolidating groups of people (parked). Short version: converge the consumers, never the tables β a team is not a group with extra fields, and merging learning groups into people groups would silently widen what every existing learning group can be used for.
Everything else routes through team, which is the de facto standard principal β except the two newest consumers, Knowledge and the LMS, which are the two that needed to reach portal users and so grew their own answers.
- Knowledge:
knowledgeViewerPrincipals()inincludes/knowledge/visibility.phpturns a viewer into["analyst:5", "team:2", "user_group:7"]and matches againstknowledge_acl. - LMS:
lmsAssignmentReachSql()inincludes/lms_access.phpbuilds aWHEREfragment per learner;lmsAssignedLearnersSql()goes the other way.
Both apply the people-group expiry at read time. Nothing sweeps expired rows, so "who had access and until when" stays answerable and there is no job to fail.
These attach a set of people to one record. They are not groups, cannot be reused, and should not become groups.
| Table | The list on | Notes |
|---|---|---|
change_cab_members |
one change | Carries is_required and a vote
|
task_collaborators |
one task | The "Involved" people; carries is_completed
|
warroom_channel_members |
one channel | |
watchtower_item_members |
one analyst's dashboard | Per-analyst, not shared |
rfp_scores, rfp_invited_suppliers
|
one RFP |
This is the right shape for all of them. Each carries per-membership state that only makes sense against that record β a vote, a tick, a score. Hoisting any of them into a reusable group would mean inventing somewhere to put that state.
If you are tempted to add a "group" and your members need per-membership data, you probably want one of these instead.
Two tables are named *_groups and contain no people. Both are easy to trip over when grepping.
-
process_groupsβ a coloured box on a Process Mapper diagram. Columns arex,y,width,height,colour. Nothing to do with people. -
morningChecks_Groupsβ a group of checks, not of people. It hasAssignedTeamID/AssignedAnalystID, so it routes to people, but its members are checks.
| Concept | What it is | Watch out for |
|---|---|---|
| Company / tenant |
tenants, plus tenant_id on people and records |
An axis of visibility, not a group you assign to. analyst_tenant_access says which companies an analyst can reach. |
| Department (the table) |
departments + department_id on tickets |
A ticket-routing category. Teams see departments via department_teams. |
| Department (the column) |
analysts.department, users.department β free text |
An HR attribute, often directory-synced. π΄ Completely unrelated to the departments table. Same word, two meanings, no link between them. |
| RFP department | rfp_departments |
A third thing called department, local to the RFP builder. |
| Role | rbac_roles |
A group of capabilities, not of people. Granted to analysts and teams. |
π΄ "Department" is the most overloaded word in the schema. Three unrelated meanings. If you are writing anything that touches one, say which.
-
Does it need to reach portal users? Then it must accept a people group (or an individual
user). Nothing else can hold one. - Is it about what somebody may do? Then it is teams and RBAC roles, not a new group.
- Does membership carry state β a vote, a tick, a score, an expiry that only means something here? Then it is a per-record list, not a group.
-
Otherwise, accept the existing principals. Store
(type, id)the wayknowledge_aclandlms_course_assignmentsdo, and resolve through the module's own helper.
Do not add a fourth reusable grouping. The people-group table exists precisely because the third one was about to be created, and it already spans both populations.
- People Groups Β· developer guide
- Training for Portal Users Β· developer guide
- Knowledge Folders and Permissions
- Consolidating groups of people β π what to do about the asymmetry above, and why the obvious fix is wrong (parked)
- Roles and Permissions β teams, roles and module access
- Multi-Tenancy β companies as an axis of visibility
FreeITSM β an open-source IT Service Management platform Β· github.com/edmozley/freeitsm Β· MIT licence
- Installation
- β° Scheduled tasks (cron jobs)
- Architecture
- π§ͺ Developer tests
- AI Providers
- Internationalisation (i18n)
- Timezones & Time Handling
- π Date & Time Formats
- Theming & Dark Mode
- ποΈ Recent β getting back to what you were doing
- β¨οΈ Command palette (βK)
- π Searching inside tickets
- π Attached documents
-
MobileβFriendly
- β³ π« Mobile: Tickets
- β³ π» Mobile: Assets
- β³ π Mobile: Calendar
- β³ π Mobile: Knowledge
- β³ π¦ Mobile: Service Status
- β³ πΌ Mobile: Watchtower
- β³ π§© Mobile: Problem Management
- β³ π Mobile: Change Management
- β³ πΏ Mobile: Software
- β³ β Mobile: Tasks
- β³ π Mobile: Forms
- β³ π Mobile: Contracts
- β³ π Mobile: Domains
- β³ π Mobile: People
- β³ π Mobile: LMS
- β³ πΊοΈ Mobile: CMDB
- β³ πΊοΈ Mobile: Network Mapper
- β³ π§ Mobile: Process Mapper
- β³ βοΈ Mobile: Workflow
- β³ π₯οΈ Mobile: System
- β³ π Mobile: Reporting
- β³ π Mobile: System Wiki
- β³ π Mobile: Self-Service Portal
- β³ π§° Mobile: Techniques & Tricks
-
Security
- Layer 1 β which modules you can enter
- β³ π§© Module Access Control
- β³ π οΈ Module Access β Developer Guide
- Layer 2 β what you can administer
- β³ π Roles & Permissions
- β³ π οΈ Roles β Developer Guide
- β³ π€ Why capabilities are constants
- Layer 3 β the System module
- β³ π Admin Access Control
- Hardening
- β³ π Security review response 2026-08
- β³ π‘οΈ Security hardening 2026-08
- β³ π οΈ Security hardening 2026-08 β Developer Guide
- β³ π‘οΈ Round three β plain English
- β³ π οΈ Round three β Developer Guide
- β³ π‘οΈ CSRF protection (S4) β Developer Guide
- Single Sign-On (SSO)
- ποΈ LDAP & Active Directory
- π CardDAV contact sync
- Browser Extension
- API Reference
-
π REST API β how it works
- β³ π« REST API: Tickets
- β³ π» REST API: Assets
- β³ π΄ REST API: Problems
- β³ π REST API: Changes
- β³ π REST API: Knowledge
- β³ β REST API: Tasks
- β³ ποΈ REST API: CMDB
- β³ π REST API: Contracts
- β³ ποΈ REST API: Calendar
- β³ πΏ REST API: Software
- β³ π REST API: Domains
- β³ π¦ REST API: Service Status
- β³ βοΈ REST API: Morning Checks
- β³ π REST API: Forms
- β³ βοΈ REST API: Workflow
- β³ π·οΈ REST API: Cost centres
- β³ πΊοΈ REST API: Network Mapper
- β³ π§ Using the API docs page
- β³ π OpenAPI specification
- β³ β OpenAPI: kept correct
- β³ π οΈ Maintaining the catalogue
- Watchtower
-
Tickets
- β³ π Rota copy and paste β Developer Deep Dive
- β³ β Checklists & SOPs
- β³ βοΈ Mandatory fields
- β³ π·οΈ Ticket categories
- β³ π₯ Assigning tickets to a team, and escalation
- β³ π’ One board across every company
- β³ Mailbox Authentication
- β³ π€ Email send log
- β³ Basic IMAP mailboxes
- β³ Email rendering & images
- β³ SLA Management
- β³ WhatsApp channel
-
β³
βοΈ Telegram channel - β³ β CSAT company scope and filters β Developer Guide
- β³ π₯ Microsoft Teams channel
- β³ π¨οΈ Mattermost channel
- β³ π¬ Web chat channel
- β³ π£ Slack channel
- β³ π Linking tickets
- β³ β Record previews
- β³ π Ticket notes: internal or shared
- β³ ποΈ Canned responses
- β³ βοΈ Limiting replies to particular senders
- β³ π¨ Telling the analyst a ticket is theirs
- β³ βοΈ Email signatures
- β³ π The public web address
- β³ π’ Ticket numbering
- β³ π Raising a ticket for someone else
- β³ π Merging tickets
- β³ π Confidential tickets
- β³ π₯ Portal managers
- β³ π Who has seen a ticket
- β³ π Reading long tickets
- β³ β Splitting tickets
- β³ β Selecting several tickets
- β³ ποΈ The folder pane
- β³ π½ Just my tickets, or no closed ones
- β³ π οΈ Snoozing tickets β Developer Guide
- β³ π₯ Collision detection
- β³ β±οΈ Time tracking
- β³ π Scheduled work in your own calendar
- Problem Management
- Tasks
-
Assets
- β³ π’ Moving an asset between companies
- β³ π Shared asset locations
- β³ π§βπΌ Assigning assets to analysts
- β³ π Warranty and lease alerts
- β³ π Saved table views
- β³ π¨οΈ Recording anything, and importing it
- β³ π·οΈ QR asset labels
- β³ π Who holds what, and handover documents
- β³ π₯οΈ The inventory agent (PowerShell)
- β³ ποΈ Proxmox VE servers
- β³ βοΈ VMware Cloud Director servers
- β³ π Linking equipment to tickets
- β³ βοΈ Follow-up tasks on a ticket
- Knowledge
- Change Management
- Calendar
- Morning Checks
- Reporting
- Software
-
Forms
- β³ π¨ The form designer β Developer Guide
- β³ π Layout & the grid β Developer Guide
- β³ ποΈ Collections β grouping submissions
- β³ π Submissions as PDFs
- β³ β‘ What happens next β a form's own actions
- β³ π οΈ Sections & conditional logic β Developer Guide
- β³ π οΈ Lookup fields β Developer Guide
- β³ π‘οΈ Catalogue request approvals
- People
- Domains
- Contracts
- Service Status
- π Notifications
- π¨ War Room
- Self-Service Portal
- LMS
- Process Mapper
- CMDB
- Network Mapper
- Workflows
- Issue trackers (Jira, Azure DevOps)
- System
-
Overview
- β³ π Progress tracker
- β³ Concepts & vocabulary
- β³ Email routing & mailboxes
- β³ Settings: global vs per-company
- β³ Users & self-service
- β³ Staff cross-company access
- β³ π’ One board across every company
- β³ Worked examples
- β³ Pitfalls & gotchas
- β³ Scope: what it's for
- β³ π οΈ Developer Guide (make a module multi-company)
- β³ ποΈ Case study: CMDB (a linked graph)
- β³ π§ͺ Test harness (prove it's isolated)
- What this is
-
π Bugs resolved
- β³ π’ Chat tickets ignored your ticket numbering
- β³ π Dates shown as a dash, or in server time
- β³ π Assets β Users showed people from other companies
- β³ π Restricted analysts could read other modules' data
- β³ πΌοΈ Replies with a picture in the thread failed to send
- β³ π Reply attachments never reached the customer
- β³ π οΈ Outbound email attachments β Developer Guide
- β³ π A global SSO provider was missing from the portal
- β³ π Behind a proxy, the SSO redirect said http
- β³ βοΈ The portal tagline moved when you saved it
- β³ π¨ The portal settings screen forgot what you saved
- β³ π‘οΈ The approvals inbox said "Error" and nothing else
- β³ π A table's answers were missing from the PDF
- β³ β A single-select column let you tick every option
- β³ π The portal ignored a form's field widths
- β³ π The tasks board stopped taking clicks
- β³ ποΈ #121 The index list is out of date after upgrading
- β³ π #133 The calendar subscription was empty
- β³ π #131 Tasks always reopened on the board
- β³ π₯ #129 Every page returned HTTP 500 after upgrading
- β³ π³ #127 A PHP warning above the System page
- β³ π #126 Notes stamped with the server's clock
- β³ π Storing every date in UTC
- β³ πͺ The portal was down for everyone signed in
- β³ βοΈ #120 Workflow notes could never be written
- β³ βοΈ #123 Three errors when running Database Verification
- β³ π #122 The description box was a stub in the corner
- β³ π£ Demo data deleted real accounts
- β³ π #117 Sign-in redirected to the wrong address
- β³ π¨ #108 The priority dot was invisible
- β³ β±οΈ #116 Time logged from the right-click menu
- β³ π #114 API keys refused by our own guard
- β³ ποΈ #110 Assigning a task told nobody
- β³ πͺ #107 Signed out while still working
- β³ π #103 "Share with Requester" reached nobody
- β³ π #102 Search found nothing for hyphens
- β³ πͺ #101 Source code editor opened behind
- β³ βοΈ #88 Subtasks could not be ticked off
- β³ π» #84 Asset deep link selected nothing
- β³ π« #79 A new ticket arrived with no status
- β³ π§ #79 A ticket from email did not say so
- β³ π #78 Bell opened to nothing
- β³ π¬ #77 Mail only collected from Inbox
- β³ π #74 The default password could not be changed
- β³ π¦ #70 Renaming an impact level
- β³ π€ #67 App-only mailboxes could not send
- β³ π #45 Verify only ever worked for Microsoft
- β³ π #45 IMAP reported as not authenticated
- β³ βοΈ An email template stopped escaping itself
- β³ π The portal dashboard showed the wrong time
- β³ π’ The folder said 99 and the list showed 96