Privileges Setup

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 privilege controls access to a specific action — like viewing reports, editing products, or processing refunds. You typically don't need to change these unless you're creating custom access rules.

When to use this: When you need to create or manage specific access permissions that can be assigned to user roles.

Prerequisites

  • No prerequisites — privileges are foundational setup

Privileges List

📝 General Description

This page lists every individual privilege available in the system. Privileges are the atomic building blocks of the access control system — each one maps to a specific action on a specific module. While Role Privileges (Section 6.3) is used to assign these privileges to roles, this page is where the privilege entries themselves are defined and managed.

⚙️ UI Elements

ElementTypeFunction
+ Add NewGreen ButtonCreate a custom privilege entry
Search BarText InputFilter by privilege name or code
🔽 FilterFunnel IconToggle advanced filter options (show/hide deleted)

Use Setup to manage and configure this feature in your EQuipWeb system.

6.4.1 Data Grid Columns

ColumnDescription
Privilege NameHuman-readable name (e.g., "View Product", "Edit Membership") — clickable → opens edit form
Privilege CodeSystem identifier used internally (e.g., MasterData.Product.View)
DescriptionExplanation of what this privilege controls
ModuleThe module category this privilege belongs to (e.g., "EQuip Setup", "Inventory", "POS")
Access TypeThe action type: View, Edit, Delete, or Setting
DeletedHidden/deleted status

Use Setup to manage and configure this feature in your EQuipWeb system.

6.4.2 Add / Edit Privilege

Form Fields

FieldTypeRequiredDescription
Privilege NameText✅ YesHuman-readable label (e.g., "Export Product Data")
Privilege CodeText✅ YesUnique system code following the pattern Module.Entity.Action (e.g., MasterData.Product.Export)
DescriptionTextareaNoDetailed explanation of what this privilege grants

Actions

ButtonFunction
SaveSaves the privilege definition
Save & NewSaves and opens a blank form
DeleteRemoves the privilege (revokes it from all roles)
RestoreRestores a safely deleted privilege

Use Setup to manage and configure this feature in your EQuipWeb system.

6.4.3 How Privileges Work

Privileges are organized in a three-tier hierarchy:

Module (e.g., "EQuip Setup")
  └── Entity (e.g., "Product", "Membership", "User")
       └── Action (e.g., "View", "Edit", "Delete", "Setting")

Access Type Reference

Access TypeWhat It Controls
ViewCan the user see/access the page or module
EditCan the user create or modify records
DeleteCan the user soft-delete or permanently remove records
SettingCan the user access module-specific configuration settings

Standard Privilege Naming Convention

PatternExample
Module.Entity.ViewMasterData.Product.View
Module.Entity.EditMasterData.Product.Edit
Module.Entity.DeleteMasterData.Product.Delete
Module.Entity.SettingMasterData.Product.Setting

Use Setup to manage and configure this feature in your EQuipWeb system.

6.4.4 Privilege Categories

The system privileges are organized across these module categories:

CategoryCovers
EQuip SetupAll Setup module pages — Product, Membership, Sales, Commission, User Setup, Delivery, Master Data, Menu Management, QR Online Ordering, Data Importer, Settings
InventoryStock In, Stock Out, Transfer, Stock Take, Purchase Orders, Goods Received
Staff WebStaff-facing web features (attendance, scheduling)
POS & OthersPOS terminal operations — sales, payments, voids, discounts, reports

Use Setup to manage and configure this feature in your EQuipWeb system.

💡 Example

Scenario: A retailer wants to create a custom privilege that allows specific roles to export member data — a sensitive action that should be restricted.

Setup:

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

  1. Enter:

  • Privilege Name: Export Member Data
  • Privilege Code: Membership.Member.Export
  • Description: Allows exporting the full member database to Excel

  1. Click Save.

Expected Result: The privilege is saved.

4. Go to Role Privileges (Section 6.3) → Select "Admin" role.

  1. Find the new "Export Member Data" privilege and toggle it ON.

6. Leave it OFF for Cashier and Supervisor roles.

[!IMPORTANT] This page is intended for advanced administrators only. Modifying or deleting system-default privileges can break access control for existing roles. Most permission management should be done through Role Privileges (Section 6.3) instead.

[!TIP] When creating custom privileges, follow the Module.Entity.Action naming convention to keep them consistent with system-generated privileges. This makes the Role Privileges matrix easier to read and manage.


Use Setup to manage and configure this feature in your EQuipWeb system.

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.


Use Setup to manage and configure this feature in your EQuipWeb system.

How to Add a New Privileges

  1. Navigate to Privileges 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 privileges.

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


How to Edit a Privileges

  1. Navigate to Privileges 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 privileges is updated and changes take effect immediately.


How to Delete a Privileges

  1. Navigate to Privileges 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 privileges 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.


Use Setup to manage and configure this feature in your EQuipWeb system.

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

Use Setup to manage and configure this feature in your EQuipWeb system.

  • 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

Use Setup to manage and configure this feature in your EQuipWeb system.

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.


Business Rules

  • Records that are linked to active transactions or other modules cannot be permanently deleted
  • Changes made here will take effect on POS terminals after the next sync
  • Deleted records can be restored from the list using the Show Deleted filter
  • All changes are logged with the user who made them and the timestamp
    • 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 ...
    • 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. ...
    • 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 ...