Role Profiles Module Documentation

Module Overview (Technical)
Module Overview (Commercial/Business)
Module Overview (End User/Administrator)
Configuration Sections
Settings Reference
Common Scenarios & Examples
Limitations & Important Notes
Troubleshooting Tips
Glossary

---

1. Module Overview (Technical)

What Are Role Profiles?

Role Profiles is a permission management module that defines access levels for admin panel users. Each role profile contains a permissions matrix specifying access (Full Control, Read Only, No Access) for every module in the system.

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Role Profiles Architecture                        │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Role Profiles Definition                                       │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Role Profile: Operator                            │   │
│  │                                                          │   │
│  │  Permissions Matrix:                                     │   │
│  │  ├─ Dashboard → Full Control                            │   │
│  │  ├─ Extensions → Full Control                           │   │
│  │  ├─ Ring Groups → Read Only                             │   │
│  │  ├─ Queues → Read Only                                  │   │
│  │  ├─ System Settings → No Access                         │   │
│  │  ├─ Users → No Access                                   │   │
│  │  └─ ...                                                 │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Assigned to users                                      │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Users                                             │   │
│  │                                                          │   │
│  │  User: jsmith → Role: Operator                          │   │
│  │  User: admin → Role: Administrator                      │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Applied at runtime                                     │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Access Control                                    │   │
│  │                                                          │   │
│  │  Menu visibility based on permissions                    │   │
│  │  API access based on permissions                         │   │
│  │  UI actions based on permissions                         │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

Table	Purpose
`public.role_profiles`	Role definitions
`public.role_permissions`	Permission matrix

Key Files

File	Description
`modules/roleProfiles/`	Frontend module

---

2. Module Overview (Commercial/Business)

Business Value

Role Profiles provides granular access control:

Without Role Profiles	With Role Profiles
All or nothing	Granular control
Single admin type	Multiple roles
No customization	Custom permissions
Security risk	Least privilege

Use Cases

Operator Role

- Day-to-day operations

- Limited system access

Support Role

- Read-only diagnostics

- No configuration changes

Department Admin

- Full access to subset

- Restricted system settings

Auditor Role

- Read-only everything

- Compliance review

Feature Highlights

Feature	Benefit
Permissions Matrix	Per-module control
Three Levels	Full, Read, None
Custom Roles	Create any role
User Assignment	Link profiles to users
Inheritance	Visual inherited markers
Duplicate	Clone and modify

---

3. Module Overview (End User/Administrator)

What Can You Do?

Create custom role profiles
Set permissions per module
Choose Full Control, Read Only, or No Access
Assign profiles to users
Duplicate existing profiles
Search and filter permissions

Role Profiles Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Role Profiles                                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [+ Create Profile]                                             │
│                                                                 │
│  [🔍 Search role profiles...]                                   │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Profile Name   │ Description          │ Users │ Permissions│ │
│  ├────────────────┼──────────────────────┼───────┼────────────┤ │
│  │ Administrator  │ Full system access   │ 2     │ 45 items   │ │
│  │ Operator       │ Day-to-day ops       │ 5     │ 30 items   │ │
│  │ Support        │ Read-only access     │ 3     │ 20 items   │ │
│  │ Billing        │ CDR and reports      │ 2     │ 8 items    │ │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Create/Edit Role Profile

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Edit Role Profile                                  │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ▼ Basic Information                                            │
│                                                                 │
│  Profile Name: [Operator                    ]                  │
│    Name displayed in role selectors                             │
│                                                                 │
│  Description: [Day-to-day operations        ]                  │
│    Optional description to clarify this role profile           │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  ▼ Permissions Matrix                                           │
│                                                                 │
│  Select the permission level for each module.                   │
│  🔵 Blue dots indicate inherited permissions.                   │
│                                                                 │
│  [🔍 Search modules...]                                         │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ Module / Feature        │ Full │ Read │ None │             ││
│  ├─────────────────────────┼──────┼──────┼──────┼─────────────┤│
│  │ ▼ Dashboard             │  ●   │  ○   │  ○   │             ││
│  │ ▼ Telephony             │      │      │      │ 5 groups    ││
│  │   ├─ Extensions         │  ●   │  ○   │  ○   │             ││
│  │   ├─ Ring Groups        │  ○   │  ●   │  ○   │             ││
│  │   ├─ Queues             │  ○   │  ●   │  ○   │             ││
│  │   └─ Conferences        │  ●   │  ○   │  ○   │             ││
│  │ ▼ Routing               │      │      │      │ 3 groups    ││
│  │   ├─ Inbound Routes     │  ●   │  ○   │  ○   │             ││
│  │   ├─ Outbound Routes    │  ○   │  ○   │  ●   │             ││
│  │   └─ IVR                │  ●   │  ○   │  ○   │             ││
│  │ ▼ System                │      │      │      │ 4 groups    ││
│  │   ├─ System Settings    │  ○   │  ○   │  ●   │             ││
│  │   ├─ Users              │  ○   │  ○   │  ●   │             ││
│  │   └─ Role Profiles      │  ○   │  ○   │  ●   │             ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

Duplicate: Clone existing profile as starting point.

TIP

Search Modules: Find specific modules quickly.

WARNING

Users Assigned: Cannot delete profile with assigned users.

---

4. Configuration Sections

Basic Information

Field	Description
Profile Name	Display name
Description	Purpose explanation

Permissions Matrix

Column	Description
Module	System module/feature
Full Control	Create, read, update, delete
Read Only	View only, no changes
No Access	Hidden from user

---

5. Settings Reference

Permission Levels

Level	Icon	Capabilities
Full Control	●	Create, Read, Update, Delete
Read Only	●	Read only
No Access	●	Hidden

Module Groups

Group	Modules
Dashboard	Main dashboard, widgets
Telephony	Extensions, Ring Groups, Queues
Routing	Inbound, Outbound, IVR
Gateways	Trunks, Carriers
Reports	CDR, Statistics
System	Settings, Users, Profiles

Default Profiles

Profile	Description
Administrator	Full access to everything
Operator	Day-to-day operations
User	Basic read access

---

6. Common Scenarios & Examples

Scenario 1: Create Operator Role

Click "Create Profile"
Name = "Operator"
Description = "Day-to-day operations"
Set Extensions = Full Control
Set Ring Groups = Full Control
Set System Settings = No Access
Set Users = No Access
Save

Scenario 2: Read-Only Auditor

Click "Create Profile"
Name = "Auditor"
Set all modules = Read Only
Save

Scenario 3: Duplicate and Modify

Find existing profile
Click Duplicate
Rename to new name
Adjust permissions
Save

Scenario 4: Department-Specific Role

Create new profile
Name = "Sales Manager"
Full Control: Extensions, Queues, CDR
Read Only: Ring Groups
No Access: System, Gateways
Save

---

7. Limitations & Important Notes

Technical Notes

NOTE

User Assignment: Delete users or reassign before deleting profile.

NOTE

Menu Visibility: No Access hides menu items.

WARNING

System Profiles: Some profiles may be protected.

Best Practices

Least Privilege: Grant minimum required access
Document Roles: Describe each profile purpose
Regular Review: Audit permissions periodically
Use Inheritance: Build on existing profiles
Test Roles: Verify access before deployment

Permission Precedence

Scenario	Result
Full Control selected	All operations allowed
Read Only selected	View only
No Access selected	Module hidden

---

8. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
Can't delete profile	Users assigned	Reassign users first
Menu not visible	No Access set	Grant Read or Full
Can't edit	Read Only access	Need Full Control
Search not working	Wrong module name	Check spelling

Check Profile Assignments

Sql

SELECT 
  u.username,
  r.name AS role_profile
FROM public.users u
JOIN public.role_profiles r ON r.id = u.role_profile_id
ORDER BY r.name;

Verify Permissions

Assign role to test user
Login as test user
Verify menu visibility
Test create/edit operations

---

9. Glossary

Term	Definition
Role Profile	Permission set
Permissions Matrix	Module access grid
Full Control	Complete access
Read Only	View only access
No Access	Hidden/blocked
Inheritance	Permission from parent

---

Lua Script Status ℹ️

Admin Module

Component	Status
Role Profiles	ℹ️ Admin panel module - no Lua handler required

Role Profiles is an administration module. Permissions control access to the web admin panel. No Lua handlers are used - access control is enforced by the backend API and frontend routing.

---

Documentation last updated: January 2026

Role Profiles Module Documentation

Table of Contents

1. Module Overview (Technical)

What Are Role Profiles?

Architecture

Key Tables

Key Files

2. Module Overview (Commercial/Business)

Business Value

Use Cases

Feature Highlights

3. Module Overview (End User/Administrator)

What Can You Do?

Role Profiles Interface

Create/Edit Role Profile

Quick Tips

4. Configuration Sections

Basic Information

Permissions Matrix

5. Settings Reference

Permission Levels

Module Groups

Default Profiles

6. Common Scenarios & Examples

Scenario 1: Create Operator Role

Scenario 2: Read-Only Auditor

Scenario 3: Duplicate and Modify

Scenario 4: Department-Specific Role

7. Limitations & Important Notes

Technical Notes

Best Practices

Permission Precedence

8. Troubleshooting Tips

Common Issues

Check Profile Assignments

Verify Permissions

9. Glossary

Lua Script Status ℹ️

Admin Module