Skip to main content
Version: 5.0 🚧

Roles

Overview​

The Roles page is used to manage role-based access in the system. Use this page to:

  • Create roles and assign them to a parent role.
  • Assign one or more groups to a role.
  • Review role hierarchy, assigned groups, assigned employees, and child roles.
  • Edit role details and permissions.
  • Set the default role used for self-registration.
  • Remove roles that are no longer needed.

This page helps administrators control which users can access product areas and which actions they can perform.

Roles (light) Roles (dark)

Before you begin​

Required permissions​

  • You must have permission to view roles.
  • You must have permission to add roles.
  • You must have permission to edit roles.
  • You must have permission to remove roles.
  • You must have permission to view role permissions.
  • You must have permission to edit role permissions.
info

Access to the Roles page and role permission settings is controlled by the role permission group named Roles.

Preconditions​

  • At least one parent role must exist before you can create a role that belongs to another role.
  • Groups must exist before they can be assigned to a role.
  • To change self-registration settings, the system must support self-registration.

Dependencies​

  • Role access depends on the permissions enabled for the role.
  • Group visibility and assignment depend on existing groups in the system.
  • Child role relationships depend on the selected parent role.
  • Self-registration depends on the configured registration mode and default role.

Important limitations​

warning
  • Removing a role is permanent and cannot be undone.
  • A role cannot be removed while it has child roles or assigned employees.
  • Changing permissions can immediately affect what users assigned to the role can view or do.
  • Built-in roles can have predefined permission sets. Review permissions before making changes.

Page layout​

Roles page header (light) Roles page header (dark)

The page header identifies the page, shows the role count, and provides the entry point for creating a role. The Remove bulk action appears after you select one or more roles in the grid.

CalloutUI elementDescriptionWhen to use
1Page titleShows the current page name: Roles.Use to confirm that you are on the role management page.
2+ add iconOpens the Create role modal.Use to create a role.
3Roles countShows the number of roles currently listed, for example, 10 roles.Use to confirm the total after creating or removing roles.
4Remove buttonAppears in the page header after you select one or more roles.Use to remove selected roles when they are no longer needed.

Roles grid​

Roles grid (light) Roles grid (dark)

The roles grid lists roles and shows their hierarchy, statistics, creator, and available actions.

CalloutUI elementDescriptionWhen to use
1CheckboxSelects one or more roles.Use to show the bulk Remove action in the page header.
2Role columnShows the role name and role type. Role types can include Default, Dealer, and Installer. The default registration role is marked with a check icon.Use to identify the role and confirm whether it is the default registration role.
3Parent columnShows the parent role for the role.Use to understand the role hierarchy.
4Statistics columnShows counts for assigned groups, assigned employees, and child roles.Use to review role usage before editing or removing a role.
5Creator columnShows the employee who created the role.Use for audit and ownership review.
6Row actions menuShows a three vertical dots menu for a specific role.Use to edit the role, edit permissions, set the default registration role, or remove the role.

Create role modal​

Create role modal (light) Create role modal (dark)

The Create role modal opens when you select the + add icon in the page header.

CalloutUI elementDescriptionWhen to use
1Modal titleShows the modal name: Create role.Use to confirm that you are creating a role.
2Name fieldStores the role name.Use to enter a clear role name.
3Belongs to role dropdownSets the parent role for the new role.Use to place the role in the role hierarchy.
4Groups dropdownAssigns one or more groups to the role. Multiple groups can be selected.Use to define which groups are associated with the role.
5Cancel buttonCloses the modal without creating a role.Use when you do not want to save changes.
6Save buttonCreates the role when all values are valid.Use after you enter the required role information.

Row actions menu​

Role row actions menu (light) Role row actions menu (dark)

Each role row has a three vertical dots menu. The available actions depend on whether the role is set as the default role for registration.

CalloutUI elementDescriptionWhen to use
1Edit roleOpens the Edit role modal.Use to change the role name or assigned groups.
2Edit permissionsOpens the Edit role permissions modal.Use to enable or disable permission groups and permissions for the role.
3Set role as defaultOpens the Edit self-registration settings modal. This action is available only when the role is not already set as the default registration role.Use to set a role as the default role for registration.
4RemoveOpens the Remove role modal or shows a warning if the role cannot be removed.Use when the role is no longer needed.

Edit role modal​

Edit role modal (light) Edit role modal (dark)

The Edit role modal opens when you select Edit role from the row actions menu.

CalloutUI elementDescriptionWhen to use
1Modal titleShows the modal name: Edit role.Use to confirm that you are editing role details.
2Name fieldShows the current role name and allows edits.Use to rename the role.
3Groups dropdownShows the current assigned groups and allows changes.Use to add or remove group assignments.
4Cancel buttonCloses the modal without saving.Use when you do not want to keep changes.
5Save buttonSaves the changes when all values are valid.Use after updating role details.

Edit role permissions modal​

Permissions modal (light) Permissions modal (dark)

The Edit role permissions modal is divided into a permission search area, permission groups, permission controls, and action buttons.

CalloutUI elementDescriptionWhen to use
1Modal window nameShows the modal name: Edit role permissions.Use to confirm that you are editing permissions for the selected role.
2Search fieldSearches permissions by name.Use to find a specific permission or permission group quickly.
3Permission groupShows a permission category, such as Accounts, Groups, Units, Roles, or Server Settings.Use to review permissions by functional area.
4ToggleEnables or disables a permission or permission group.Use to set the related permission to Allow or Deny.
5PermissionShows an individual permission inside a permission group.Use to control access to a specific page, action, tab, widget, or API operation.
6Cancel buttonCloses the modal without saving changes.Use when you do not want to apply permission changes.
7Save buttonSaves the permission changes for the role.Use after reviewing all changed permissions.

Edit self-registration settings modal​

Edit self-registration settings modal (light) Edit self-registration settings modal (dark)

The Edit self-registration settings modal opens when you select Set role as default from the row actions menu.

CalloutUI elementDescriptionWhen to use
1Modal titleShows the modal name: Edit self-registration settings.Use to confirm that you are changing registration settings.
2Registration mode dropdownControls how self-registration requests are handled.Use to select Manual approval, Automatic approval, or Disabled.
3Default role dropdownShows the current role and allows another role to be selected.Use to choose which role is assigned during registration.
4Cancel buttonCloses the modal without saving.Use when you do not want to change registration settings.
5Save buttonSaves the self-registration settings.Use to set the selected role as the default registration role.

Remove role modal​

Remove role modal (light) Remove role modal (dark)

The Remove role modal opens when you select Remove from the row actions menu or the bulk action button.

CalloutUI elementDescriptionWhen to use
1Modal titleShows the modal name: Remove role.Use to confirm that you are removing a role.
2Warning messageShows the message: Are you sure you want to permanently remove role name role? This action cannot be undone.Review before removing the role.
3Cancel buttonCloses the modal without removing the role.Use when you do not want to remove the role.
4Yes, remove buttonPermanently removes the role when removal is allowed.Use only when the role is no longer needed.

Pagination controls​

Roles pagination controls (light) Roles pagination controls (dark)

Pagination controls appear at the bottom of the roles grid.

CalloutUI elementDescriptionWhen to use
1Previous and next arrowsMove between pages in the roles grid.Use when the role list has more records than the current page can show.
2Range indicatorShows the current range and total number of roles, for example, 1-15 of 25.Use to understand where you are in the role list.
3Roles per page selectorControls how many roles appear on one page. Available values are 10, 15, 50, 100, and 200.Use to change the grid page size.

How to use this page​

Create a role​

Goal:

  • Create a role, set its parent role, and assign groups.

Steps:

  1. Open the Roles page.
  2. Select the + add icon in the page header.
  3. In the Create role modal, enter a value in the Name field.
  4. Select a parent role from the Belongs to role dropdown.
  5. Select one or more groups from the Groups dropdown.
  6. Select Save.

Expected result:

  • The role is created.
  • The role appears in the roles grid.
  • The Parent and Statistics columns show the relevant values.

Edit a role​

Goal:

  • Change a role name or update its assigned groups.

Steps:

  1. Open the Roles page.
  2. Find the role in the grid.
  3. Select the three vertical dots menu for the role.
  4. Select Edit role.
  5. In the Edit role modal, update the Name field or Groups dropdown.
  6. Select Save.

Expected result:

  • The role is updated.
  • The roles grid shows the latest role name and statistics.

Edit role permissions​

Goal:

  • Enable or disable permission groups and individual permissions for a role.

Steps:

  1. Open the Roles page.
  2. Find the role in the grid.
  3. Select the three vertical dots menu for the role.
  4. Select Edit permissions.
  5. In the Edit role permissions modal, use the search bar to find a permission group or permission.
  6. Expand a permission group to review its permissions.
  7. Use the toggle next to a permission group or permission to enable or disable it.
  8. Review the selected permissions before you close the modal.

Expected result:

  • The role permissions are updated according to the selected toggles.
  • Users assigned to the role receive access based on the enabled permissions.
warning

Review permission changes before closing the modal. Permission changes can affect access for all employees assigned to the role.

Set a role as the default registration role​

Goal:

  • Configure which role is assigned during self-registration.

Steps:

  1. Open the Roles page.
  2. Find a role that is not already marked as the default registration role.
  3. Select the three vertical dots menu for the role.
  4. Select Set role as default.
  5. In the Edit self-registration settings modal, select a Registration mode:
    • Manual approval
    • Automatic approval
    • Disabled
  6. Review the Default role dropdown. Change the selected role if needed.
  7. Select Save.

Expected result:

  • The selected role is set as the default registration role.
  • The role is marked with a check icon in the Role column.

Remove a role​

Goal:

  • Permanently remove a role that is no longer needed.

Steps:

  1. Open the Roles page.
  2. Find the role in the grid.
  3. Review the Statistics column for assigned employees and child roles.
  4. Select the three vertical dots menu for the role.
  5. Select Remove.
  6. In the Remove role modal, review the warning message.
  7. Select Yes, remove.

Expected result:

  • The role is removed.
  • The role no longer appears in the roles grid.
danger

This action cannot be undone. A role cannot be removed while it has assigned employees or child roles.

Remove selected roles​

Goal:

  • Remove one or more selected roles from the grid.

Steps:

  1. Open the Roles page.
  2. Select the checkbox for each role you want to remove.
  3. Select Remove in the page header.
  4. Review the remove confirmation message.
  5. Confirm the removal.

Expected result:

  • Roles that can be removed are deleted.
  • Roles with assigned employees or child roles are not removed until those dependencies are cleared.

Review role statistics​

Goal:

  • Check group assignments, employee assignments, and child roles before editing or removal.

Steps:

  1. Open the Roles page.
  2. Find the role in the grid.
  3. Review the Statistics column.
  4. Hover over the assigned groups count to view group names.
  5. Hover over the assigned employees count to view the assigned employee count.
  6. Hover over the child roles count to view the child role count.

Expected result:

  • The tooltip shows additional information about the selected statistic.
  • You can decide whether the role can be safely edited or removed.

Change the number of roles shown per page​

Goal:

  • Change how many roles appear in the grid.

Steps:

  1. Go to the bottom-right area of the roles grid.
  2. Open the roles per page selector.
  3. Select one of the available values:
    • 10
    • 15
    • 50
    • 100
    • 200

Expected result:

  • The grid updates to show the selected number of roles per page.
  • The range indicator updates.

Move between role pages​

Goal:

  • Navigate through multiple pages of roles.

Steps:

  1. Go to the bottom-left area of the roles grid.
  2. Select the next arrow to move forward.
  3. Select the previous arrow to move back.
  4. Review the range indicator, for example, 1-15 of 25.

Expected result:

  • The grid shows the selected page of roles.
  • The range indicator updates.

Field and option reference​

Create role fields​

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
NameRole name.Text.Identifies the role in the roles grid and dropdown lists.Must contain fewer than 255 characters.Empty.
Belongs to roleParent role for the new role.Existing role from the dropdown list.Sets the role hierarchy.A parent role must be available.Not specified.
GroupsGroups assigned to the role.One or more existing groups.Updates the assigned groups count in the statistics column.Only available groups can be selected.Empty.

Edit role fields​

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
NameCurrent role name.Text.Updates the role name after saving.Must contain fewer than 255 characters.Current role name.
GroupsCurrent groups assigned to the role.One or more existing groups.Adds or removes group assignments after saving.Only available groups can be selected.Current assigned groups.

Roles grid columns​

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
CheckboxSelects roles for bulk removal.Selected or not selected.Shows the Remove button in the page header.Removal is blocked for roles with assigned employees or child roles.Not selected.
RoleRole name and role type.Saved role name and type, such as Default, Dealer, or Installer.Shows a check icon when the role is the default registration role.Read-only in the grid.Not applicable.
ParentParent role assigned to the role.Existing role name.Shows the role hierarchy.Read-only in the grid.Depends on role configuration.
StatisticsCounts assigned groups, assigned employees, and child roles.Numbers.Shows tooltips with group names, assigned employee count, and child role count.Read-only in the grid.0 where no related records exist.
CreatorEmployee who created the role.Employee name.Supports audit and ownership review.Read-only in the grid.Set when the role is created.

Predefined roles​

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
AdministratorBuilt-in role with all permissions.Not applicable.Provides full access to all available permission groups and permissions.Use only for users who require full administrative access.Predefined.
Event Interface UserBuilt-in role for Event Interface access.Not applicable.Has only Event Interface group permissions.Use for users who work with Event Interface features.Predefined.
Default InstallerBuilt-in role for installer application access.Not applicable.Provides permissions similar to the legacy installer role.Use for installer application access.Predefined.
OperatorBuilt-in role for limited PowerManage control access.Not applicable.Provides limited control permissions.Use for users who need restricted operational access.Predefined.

Self-registration settings​

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
Registration modeControls how self-registration is handled.Manual approval, Automatic approval, Disabled.Determines whether registration requires approval, is approved automatically, or is unavailable.Changing this setting affects future registrations.Not specified.
Default roleRole assigned during registration.Existing role from the dropdown list.Marks the selected role with a check icon in the roles grid.Only one role can be the default registration role.Current default role.

Pagination options​

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
Roles per pageControls how many roles appear on one page.10, 15, 50, 100, 200.Updates the grid page size.Large page sizes may require more scrolling.15.
Range indicatorShows the current visible range and total count.System-generated value, for example, 1-15 of 25.Updates when you change page or page size.Read-only.Depends on total role count.

Sub-dealer role creation behavior​

When a sub-dealer is created on the server, two roles appear in the roles grid.

NameDescriptionAccepted valuesBehaviorRestrictionsDefault value
sub-dealer name DealerDealer role created for the sub-dealer.Generated role name.Uses Administrator as the parent. Statistics show the assigned sub-dealer group, 1 employee, and 1 child role.Depends on sub-dealer creation.Generated when the sub-dealer is created.
sub-dealer name InstallerInstaller role created for the sub-dealer.Generated role name.Uses sub-dealer name Dealer as the parent. Statistics show the assigned sub-dealer group, 0 employees, and 0 child roles.Depends on sub-dealer creation.Generated when the sub-dealer is created.

Tips​

tip
  • Review the Statistics column before removing a role. Roles with assigned employees or child roles cannot be removed.
  • Use clear role names that describe the user's responsibility or access level.
  • Use the permission search bar when you know the permission name or group name.
  • Assign the fewest permissions required for the role's work.
  • Review the default registration role after changing self-registration settings.
  • Use pagination page size 50, 100, or 200 when reviewing a large number of roles.

Troubleshooting​

Role cannot be created​

Possible causes

  • The Name field is empty.
  • The role name contains 255 or more characters.
  • A required dropdown value is missing.
  • The current user does not have permission to add roles.

What to do

  1. Confirm that the Name field is completed.
  2. Make sure the role name contains fewer than 255 characters.
  3. Select a value in Belongs to role.
  4. Select required groups if group assignment is required by your configuration.
  5. Confirm that you have permission to add roles.
  6. Try saving again.

Role cannot be edited​

Possible causes

  • The role name is invalid.
  • A selected group is no longer available.
  • The current user does not have permission to edit roles.

What to do

  1. Open the Edit role modal again.
  2. Confirm that the Name field contains fewer than 255 characters.
  3. Review the selected groups.
  4. Confirm that you have permission to edit roles.
  5. Select Save again.

Permission changes are not available​

Possible causes

  • The current user does not have permission to edit role permissions.
  • The permission group is collapsed.
  • The search term filters out the expected permission.

What to do

  1. Confirm that you have permission to edit role permissions.
  2. Clear the search bar.
  3. Expand the relevant permission group.
  4. Use the toggle next to the required permission.

Role cannot be removed​

Possible causes

  • The role has one or more child roles.
  • The role has one or more assigned employees.
  • The current user does not have permission to remove roles.

What to do

  1. Review the Statistics column for the role.
  2. Hover over the child role count to confirm whether child roles exist.
  3. Remove or reassign child roles.
  4. Unassign employees from the role.
  5. Confirm that you have permission to remove roles.
  6. Try removing the role again.

Wrong role is set as the default registration role​

Possible causes

  • The wrong role was selected in the Default role dropdown.
  • Registration settings were changed from another session.

What to do

  1. Open the Roles page.
  2. Find the role that should be the default registration role.
  3. Select the three vertical dots menu.
  4. Select Set role as default.
  5. In the Edit self-registration settings modal, confirm the Registration mode and Default role values.
  6. Select Save.

Expected role is missing from the grid​

Possible causes

  • The role is on another page of the grid.
  • The page size is too small to show all roles.
  • The role was removed.
  • The current user does not have permission to view the role.

What to do

  1. Use the pagination arrows to move through the roles grid.
  2. Increase the roles per page value.
  3. Confirm that the role was not removed.
  4. Confirm that you have permission to list roles.
Was this page helpful?