Last Updated: 2025-01-25Documentation Index
Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
Use this file to discover all available pages before exploring further.
Status: Active
Comprehensive Guide: For detailed information, see permissions-system-guide.md
Permission Key Format
hr.employees.view- View HR employeesfa.bills.approve- Approve FA billsrh.residents.create- Create RH residentssystem.platform.admin- Platform admin access
view- Read accesscreate- Create new recordsedit- Modify existing recordsdelete- Remove recordsapprove- Approval workflowsadmin- Full administrative access
Common Patterns
Component Usage
Navigation Items
RLS Policies
Role to Permission Mapping
| V1 Role (Deprecated) | V2 Permission Pattern |
|---|---|
platform_admin | system.platform.admin |
org_admin | system.platform.admin or *.admin |
site_admin | *.view + *.create + *.edit |
staff | *.view + *.create |
readonly | *.view only |
finance_admin | fa.admin + all FA permissions |
finance_staff | fa.*.view + fa.*.create |
Migration Quick Reference
Code Migration Patterns
Navigation
Components
RLS Policies
Quick Lookup Tables
Permission Categories
| Category | Description | Example |
|---|---|---|
view | Read-only access | hr.employees.view |
create | Create new records | hr.employees.create |
edit | Modify existing records | hr.employees.edit |
delete | Remove records | hr.employees.delete |
approve | Approval workflows | fa.bills.approve |
admin | Full administrative access | hr.admin |
System Permissions
| Permission | Description |
|---|---|
system.platform.admin | Platform-wide administrative access |
system.organizations.view | View organizations |
system.organizations.create | Create organizations |
system.organizations.edit | Edit organizations |
Module Prefixes
| Prefix | Module |
|---|---|
hr | Human Resources (Workforce & HRIS) |
fa | Finance & Accounting |
rh | Recovery Housing |
fw | Forms & Workflow |
fm | Facilities Management |
gr | Governance & Compliance |
lo | Leadership Operating System |
pf | Platform Foundation |
Anti-Patterns (What NOT to Do)
❌ Hardcode Role Checks
❌ Direct Database Queries
❌ Use V1 Patterns
❌ Recursive RLS Policies
Common Permission Keys
HR Module
hr.employees.viewhr.employees.createhr.employees.edithr.employees.deletehr.ats.viewhr.ats.createhr.credentialing.viewhr.credentialing.approve
Finance Module
fa.accounts.viewfa.bills.viewfa.bills.createfa.bills.approvefa.transactions.viewfa.budgets.view
Recovery Housing Module
rh.residents.viewrh.residents.createrh.residents.editrh.beds.viewrh.census.view
Forms & Workflow Module
fw.forms.viewfw.forms.createfw.workflows.viewfw.workflows.createfw.workflows.edit
Database Tables
| Table | Purpose | Status |
|---|---|---|
pf_user_role_assignments | User-to-role assignments | ✅ Active |
pf_roles | Role definitions (custom + system) | ✅ Active |
pf_role_permissions | Permission-to-role mappings | ✅ Active |
pf_permissions | Permission definitions | ✅ Active |
pf_user_roles | Legacy V1 table | 🗑️ Dropped (migrated to pf_user_role_assignments) |
References
- Comprehensive Guide - Detailed system documentation
- PF-30 Specification - Complete specification
- Module Permissions Matrix - All available permissions
- Permissions Component README - Component docs
Last Updated: 2025-01-25
Status: Active Quick Reference