Module Permissions is the page atDocumentation Index
Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
Use this file to discover all available pages before exploring further.
/settings/permissions/:module that displays all defined permissions for a specific platform module (e.g., hr, fa, rh, fw, lo, fm, cl, system), organized by category, with role usage details.
Overview
The page reads the:module param and looks up the corresponding permission set from MODULE_CONFIG (which maps module slugs to their name and permission constant map). Permissions are parsed by parsePermission to extract category, entity, and action. The page renders a filterable permission list with search and a tabbed view by category. Role usage data shows which roles include each permission. The user context is loaded via useCurrentUser.
Navigate here from /settings/permissions (Permissions Overview).
Who it’s for
No explicit permission gate on this route. SME should confirm intended access.Supported modules
| Slug | Module Name |
|---|---|
hr | Workforce & HR |
fa | Finance & Revenue |
rh | Recovery Housing |
fw | Forms & Workflow |
lo | Leadership OS |
fm | Facilities & Maintenance |
cl | Clinical |
system | System |
Before you start
- Navigate from
/settings/permissionsand select the module of interest. - This page is informational — confirm with an SME whether permission assignments are managed here or in the Roles pages.
Steps
- Navigate to
/settings/permissions/:module(e.g.,/settings/permissions/hr). - Use the search input to filter permissions by name or key.
- Select a category tab to narrow the view.
- Review each permission’s key, label, entity, and action components.
- Expand role usage details to see which roles include each permission.
Key concepts
Permission key — the dot-notation string (e.g.,hr.employees.view) used in RequirePermission gates throughout the platform.
Category — a grouping derived from the permission key structure (e.g., entity type or functional area).
Related
Platform Foundation
Platform Foundation overview.
Governance & parity
This page documents shipped product behavior. It is not medical, legal, or
billing advice. Verify against your organization’s policies and applicable
regulations before using it for clinical, compliance, or billing decisions.
Protected health information (PHI) shown in the product is governed by your
tenant’s access controls and is never exposed in this documentation.
Documentation sources
Documentation sources
- src/routes/platform.tsx
- src/platform/permissions/pages/ModulePermissionsPage.tsx
- src/platform/permissions/constants.ts