Role Setup

Role Setup

🌐 Backend — EQuipWebRetail ModeUser Setup

Chapter 6: User Setup — 6.2 Role Setup

Use Role Setup to create job roles for your team — like "Cashier", "Supervisor", "Manager", or "Admin". Each role determines what a user can see and do in the system. Once a role is created, you assign it to staff members in the User List.

When to use this: When you need to create or manage user roles (e.g., Admin, Supervisor, Cashier).

Prerequisites

  • No prerequisites — roles are foundational setup

Role List

📝 General Description

The Role Setup list page displays all configured user roles in a data grid. Each role represents a named group that users can be assigned to. The actual permissions for each role are configured separately in Role Privileges (Section 6.3). Roles are essentially labels that group users together — they don't grant permissions on their own.

⚙️ UI Elements

ElementTypeFunction
+ Add NewGreen ButtonCreate a new role definition
ExportOrange ButtonExport the role list to Excel
Search BarText InputFilter roles by name
🔽 FilterFunnel IconToggle advanced filter options (show/hide deleted)

6.2.1 Data Grid Columns

ColumnDescription
Group NameThe role name (clickable → opens edit form). Examples: "Admin", "Cashier", "Supervisor", "System Admin"
DescriptionBrief description of the role's intended purpose
DeletedHidden/deleted status — indicates if the role has been deactivated

6.2.2 Add / Edit Role

Form Fields

FieldTypeRequiredDescription
Group NameText✅ YesUnique role identifier (e.g., "Store Manager", "Warehouse Staff", "Cashier Lead"). This name appears in user profiles and access logs.
DescriptionTextareaNoFree-text description explaining the role's intended scope and responsibilities

Actions

ButtonFunction
SaveSaves the role and returns to the list
Save & NewSaves the role and opens a blank form for a new entry
DeleteRemoves the role (hidden from dropdowns but existing users keep their assignment)
RestoreRestores a previously deleted role

6.2.3 Default System Roles

The system comes pre-configured with these standard roles:

RoleTypical Use
System AdminFull access to all modules — reserved for IT administrators
AdminBack-office management — product setup, membership, reporting
SupervisorStore-level oversight — approvals, voids, discounts beyond limits
CashierPOS operations only — sales, payments, basic member lookup

[!NOTE] Default roles cannot be deleted, but their permissions can be fully customized via Role Privileges (Section 6.3). You can also create unlimited custom roles (e.g., "Warehouse Staff", "Marketing", "Finance").


6.2.4 Role-User Relationship

Each user account in User List (Section 6.1) is assigned exactly one role via the Group Name dropdown. Changing a user's role immediately changes their access level.

Role Setup → defines role names

Role Privileges → assigns permissions to each role

User List → assigns a role to each user

User logs in → permissions enforced

💡 Example

Scenario: A retail chain introduces a new "Area Manager" role for regional supervisors who need access to reports across multiple outlets but shouldn't modify product or pricing data.

Setup:

  1. Navigate to Role Setup → Click + Add New.

  1. Enter Group Name: Area Manager.

3. Enter Description: Regional supervisors — multi-outlet reporting, no edit access.

  1. Click Save.

Expected Result: The role is saved and can be assigned to users.

5. Go to Role Privileges (Section 6.3) → Select "Area Manager" from the dropdown.

  1. Grant View access to all Report modules.
  2. Grant View access to Sales Setup and Inventory modules.
  3. Leave Edit and Delete toggles off for all Setup modules.

9. Go to User List → Edit each area manager's account → Set Group Name to "Area Manager".

[!TIP] Keep role names descriptive and consistent across your organization. When support teams troubleshoot access issues, clear role names make it immediately obvious what permissions a user should have.

[!WARNING] Deleting a role does not remove the role from existing users. Users previously assigned to a deleted role will retain their last-known permissions until they are reassigned to an active role.


Access & Permissions

RoleViewCreateEditDelete
AdminYesYesYesYes
SupervisorYesYesYesNo
CashierNo backend access

[!NOTE] Exact permissions depend on the Privileges Setup configured for each role. Contact your administrator if you cannot access this page.


How to Add a New Role

  1. Navigate to Role Setup from the sidebar menu.

  1. Click the + Add New button (green button).

  2. Fill in the required fields in the form.

  1. Fill in any optional fields as needed.

  2. Click Save to create the new role.

Expected Result: The new role appears in the list and is available for use across the system.


How to Edit a Role

  1. Navigate to Role Setup from the sidebar menu.

  1. Click on the name or code link (blue text) of the record you want to edit.

  2. The edit form opens with all current values pre-filled. Modify the fields as needed.

  1. Click Save to apply your changes.

Expected Result: The role is updated and changes take effect immediately.


How to Delete a Role

  1. Navigate to Role Setup from the sidebar menu.

  1. Click on the name or code link (blue text) of the record you want to delete.

  2. In the edit form, scroll down to the bottom.

  1. Click the Delete button (red button).
  2. A confirmation dialog appears — click Yes to confirm.

Expected Result: The role is soft-deleted — hidden from active lists and POS but can be restored later.

[!WARNING] Records linked to active transactions or other modules cannot be deleted. The system will display an error if deletion is not allowed.


FAQ

Q: A user is locked out — how do I unlock them? A: Go to User Setup > Locked User to view and unlock locked accounts. Accounts may lock after multiple failed login attempts.

Q: Can a user have multiple roles? A: Each user is assigned one role. To combine permissions, create a custom role with the needed privileges in Role Setup and Privileges Setup.

Q: Why can't a user see certain menus? A: Their role may not have the required privileges. Check Privileges Setup for the user's assigned role.


Troubleshooting

IssuePossible CauseSolution
Cannot save the recordRequired fields are empty or invalidCheck all fields marked with * and fill in valid data
Record not appearing in POSPOS terminal has not synced yetWait for the next sync cycle or manually trigger sync from Terminal Status
Cannot delete the recordRecord is being used by other modulesCheck if the record is linked to active transactions, products, or other settings
Changes not taking effectBrowser cache showing old dataRefresh the page (Ctrl+F5) or clear browser cache
"Duplicate" error on saveA record with the same name/code already existsSearch the list (including deleted records) for duplicates
Page not loadingSession expired or network issueLog out and log back in. Check your internet connection

  • Setting > Feature Setup — system feature toggles
  • Master Data > Outlet Setup — outlet access assignment
  • User Setup > Role Setup — role definitions
  • User Setup > Privileges Setup — permission configuration

Open Questions / Confirmation Needed

[!NOTE] The following items may vary depending on your system version and configuration:

  • Exact permission settings depend on your Privileges Setup configuration
  • Sync timing to POS terminals depends on network conditions and sync schedule
  • Some features may require additional licensing or module activation
  • Field behavior may differ between EQuip versions

If you encounter behavior not described in this manual, contact your system administrator or EQuip support team.

    • Related Articles

    • Role Privileges Setup

      ? Backend — EQuipWebRetail ModeUser Setup Chapter 6: User Setup — 6.3 Role Privileges Use Role Privileges to decide exactly what each role can see and do. For example, you might let Cashiers process sales but block them from viewing reports or ...
    • Privileges Setup

      ? Backend — EQuipWebRetail ModeUser Setup Chapter 6: User Setup — 6.4 Privileges Setup Use Setup to manage and configure this feature in your EQuipWeb system. Privileges Setup is the master list of all permissions available in the system. Each ...
    • Company Setup

      ? Backend — EQuipWebRetail ModeMaster Data Setup Chapter 8: Master Data Setup — 8.9 Company Setup Use Company Setup (under Master Data) to enter your company's official business details — company name, registration number, address, and contact ...
    • Feature Setup

      ? Backend — EQuipWebRetail ModeSetting Setting — 12.5 Feature Setup: Toggle product features, pricing display, and system options Use Feature Setup to turn features on or off across your system. Each feature has a simple toggle switch — flip it ON ...
    • Currency Setup

      ? Backend — EQuipWebRetail ModeSales Setup Chapter 4: Sales Setup — 4.8 Currency Setup Use Currency Setup to add the currencies your business accepts. If you only accept one currency (e.g., SGD), it's already set up for you. Multi-currency ...