Roles and Permission
The Roles & Permissions page under System Settings enables administrators to create and manage business roles and define the permissions assigned to each role. Administrators can create custom roles, edit role information, assign page-level permissions through the Work Center & Permissions tree, activate or deactivate roles, and delete custom roles. Newly created roles are automatically available in the User Management module for user assignment.
Access Roles & Permissions
- Navigate to System Settings.
- Select Roles & Permissions.
The page displays a searchable and sortable table containing both System-defined and Custom roles.
Roles List
The Roles table displays all available roles along with their details.
The table includes:
- Role ID
- Role Name
- Description
- Status
- Created At
- Actions
Both System Roles and Custom Roles are displayed in the list.
Search Roles
Use the search bar to quickly locate a role.
You can search by:
- Role ID
- Role Name
- Description
If no matching records are found, the system displays “No Roles Found.”
Filter Roles
Roles can be filtered using the available filters:
- Active
- Inactive
The roles table refreshes automatically based on the selected filter.
Sort Roles
Click any sortable column header to arrange the roles in ascending or descending order.
Create a New Role
To create a new business role:
- Open Roles & Permissions.
- Click New.
- Enter the required information.
- Configure permissions if required.
- Click Save.
The New Role page contains:
- General Information
- Work Center & Permissions
The Role ID is automatically generated when the role is saved.
General Information
Provide the basic information for the role.
Role Name
Enter a unique name for the business role.
This field is mandatory.
If the role name already exists, the system displays an error and prevents saving.
Description
Optionally enter a description explaining the purpose and responsibilities of the role.
Work Center & Permissions
Use the Work Center & Permissions tab to configure access rights.
Permissions are organised in a hierarchical tree based on:
- Module
- Screen
- Available actions
Administrators can grant or revoke permissions for each module and screen.
Save the Role
After entering the required information:
- Review the role details.
- Click Save.
On successful validation:
- A unique Role ID is generated.
- The role is added to the Roles list.
- The role is synchronised with the User Management module.
- A success message is displayed.
If validation fails:
- Role Name is required is displayed when left blank.
- Role name already exists is displayed when a duplicate name is entered.
Save and Create Another Role
Click Save and New to save the current role and immediately open a blank form for creating another role.
The same validation rules apply before the new form opens.
View a Role
To view a role:
- Locate the required role.
- Click the View (Eye) icon.
The View Role page opens in read-only mode displaying:
- Role ID
- Role Name
- Description
- Status
- Work Center & Permissions configuration
Edit a Role
To update an existing role:
- Locate the required role.
- Click the Edit (Pencil) icon.
- Modify the required information.
- Click Save.
Administrators can update:
- Role Name
- Description
- Assigned permissions
The updated information is saved after successful validation.
Activate or Deactivate Roles
Administrators can activate or deactivate one or more roles.
To perform a bulk update:
- Select one or more roles.
- Choose Bulk Activate or Bulk Deactivate.
- Confirm the action.
If no roles are selected, the system displays “No roles selected.”
Delete a Role
Custom roles can be deleted from the Roles list.
System-defined roles are managed separately and are not intended for deletion.
Permission Properties
Each permission contains the following information:
- Permission ID
- Name
- Label
- Description
- Module
- Submodule
- API Endpoint
- HTTP Method
These properties define the permission, the system module it belongs to, and the associated API and request method used for access control.
Role Properties
Each role stores the following information:
- Role ID
- Tenant ID
- Role Name
- Description
- Status
- Created At
- Updated At
These properties uniquely identify the role and track its lifecycle within the system.