Roles & Permissions

Roles & Permissions

The Roles & Permissions section allows administrators to control what users can access and which actions they can perform in the application. Administrators can view existing roles, create new roles, and configure permissions for individual modules according to users' responsibilities.

Role and Permission Settings

1. View Existing Roles

The Roles & Permissions page displays the roles available in the system. Each role card shows the role name, the number of users assigned to it, and the number of permissions associated with it.

Field / OptionDescription
Role NameDisplays the name of the role, such as customer_admin, org_admin, technician, viewer, or Tester.
User CountShows how many users are assigned to the role.
Permission CountDisplays the number of permissions associated with the role.
Lock IconIndicates a system role that cannot be deleted.
Role SelectionOpens the selected role's details and permission settings.
+ New roleOpens the form to create a new role.

Steps to View a Role

  1. Open Roles & Permissions from the application settings.
  2. Review the available roles.
  3. Check the user count and permission count displayed for each role.
  4. Select the role you want to review.
  5. View the role details and its configured module permissions.

Note: System roles cannot be deleted.

2. Create a New Role

Click + New role to open the Create role form. Enter a role name and, optionally, a description explaining the purpose of the role.

Create Role Form

Fields in the Create Role Form

FieldDescriptionRequired
Role NameEnter a name for the new role, such as Site Manager.Yes
Description (Optional)Explain the purpose of the role and the responsibilities of the users assigned to it.No

Steps to Create a Role

  1. Open the Roles & Permissions page.
  2. Click + New role.
  3. In the Role Name field, enter the name of the role.
  4. Enter a description in the Description (Optional) field, if required.
  5. Click Create to create the role.
  6. Verify that the new role appears in the list.
  7. Select the newly created role to open its permission settings.

Note: Creating a role does not, by itself, define which actions users can perform. Review and configure the role's permissions after creating it.

3. View Role Details and Module Permissions

Select an existing role, such as customer_admin, to open the Role details page. This page displays the role type, user count, permission count, and the permissions configured for individual modules.

Role Details and Module Permissions

Role Information

FieldDescription
Role NameDisplays the selected role's name.
SystemIndicates that the role is a system-defined role, when displayed.
User CountShows the number of users assigned to the role.
PermissionsDisplays the number of enabled permissions and the total available permissions.
Role DescriptionExplains the purpose of the role, when a description is available.

Module Permission List

The role details page displays permissions grouped by module. Each module row includes a checkbox, the module name, a permission count, and an expand/collapse arrow.

Examples of modules visible in the screenshot include:

  • Assets
  • Audit
  • Automations
  • BMS
  • Categories
  • Checklists
  • Customer Groups
  • Customers
  • Inbound Email
  • Integrations
OptionDescription
Module CheckboxEnables or disables the permissions for the corresponding module, according to the available controls.
Module NameIdentifies the application module whose permissions can be configured.
Permission CountShows the number of enabled permissions compared with the total available for that module.
Expand/Collapse ArrowOpens or closes the module to view its individual permissions.
All changes savedIndicates that the current changes have been saved.
SaveSaves pending permission changes when enabled.

Steps to Configure Module Permissions

  1. Open Roles & Permissions.
  2. Select the role you want to configure.
  3. Review the module list displayed on the Role page.
  4. Expand a module using its arrow to view the available permissions.
  5. Review the permissions and enable or disable the required options.
  6. Repeat the process for other modules as needed.
  7. Review the permission counts to check the selected permissions.
  8. Click Save if the button is enabled and changes are pending.
  9. Confirm that the page indicates the changes have been saved.

Important: Configure permissions carefully. Enabling or disabling a module's permissions can change what users assigned to the role are allowed to access or do.

4. Update an Existing Role

You can select an existing role to review its configuration and update its permissions, where permitted.

Steps to Update a Role

  1. Open Roles & Permissions.
  2. Select the required role.
  3. Expand the module whose permissions you want to change.
  4. Update the necessary permission settings.
  5. Review the changes.
  6. Click Save if required.
  7. Verify that the changes have been saved.

Note: The available actions may differ between system roles and custom roles.

5. End-to-End Roles & Permissions Workflow

Open Application Settings
        ↓
Open Roles & Permissions
        ↓
View Existing Roles
        ↓
Choose an Existing Role
        ↓
OR
        ↓
Click + New role
        ↓
Enter Role Name
        ↓
Add Description if Required
        ↓
Click Create
        ↓
New Role Appears in the Role List
        ↓
Select the Role
        ↓
Open Role Details
        ↓
View Available Modules
        ↓
Expand the Required Module
        ↓
Configure Module Permissions
        ↓
Review Permission Counts
        ↓
Click Save if Required
        ↓
Verify That Changes Are Saved