Skip to content

Settings Module

2 min read8 sections
On this pageShow

Settings Module

System configuration: roles, locations, departments, and exchange rates

Module Purpose: Admin-only configuration for organization structure, custom roles, and multi-currency support
Primary Users: System administrators (Admin role)
Last Updated: June 4, 2026


Overview

Settings is the administrative hub for data that other modules depend on. Access is restricted in the UI to users with the Admin role (sidebar uses roles: ["Admin"]).

UI Paths

AreaRoute
Settings home/dashboard/settings
Roles list/dashboard/settings/roles
Create role/dashboard/settings/roles/new
Role detail / edit/dashboard/settings/roles/[roleId], .../edit
Locations/dashboard/settings/locations (+ new, [id], edit)
Departments/dashboard/settings/departments (+ new, [id]/edit)
Exchange rates/dashboard/settings/exchange-rates (+ new, [id], edit)

Custom roles and permissions

Admins can define custom roles with granular resource:action permissions (for example sales:create, inventory:list).

  1. Go to SettingsRoles.
  2. Click Create New Role.
  3. Name the role, select permissions in the permission matrix, and save.
  4. Assign the role to users via Users module (where supported by backend).

System roles (User, Supervisor, Manager, Admin) have default permission sets; custom roles extend or narrow access for specific job functions.

See User Roles & Permissions for the full permission model.


Locations

Locations represent warehouses, stores, or service centers.

  • Used by inventory, sales, transfers, POs, and dismantling requests
  • Users may be scoped to a location for data visibility
  • Bulk import supported (locations:import) from the locations list

Departments

Departments organize employees and reporting structure.

  • Create and edit under SettingsDepartments
  • Referenced in employee and user records where applicable

Exchange rates

Exchange rates support multi-currency pricing and reporting.

  • Maintain rates under SettingsExchange Rates
  • Bulk import via exchange-rates:import
  • Used where product or transaction pricing references foreign currency

SettingUsed by
LocationsInventory, sales, POs, transfers, spare parts
DepartmentsEmployees, users
RolesAll modules (permission checks)
Exchange ratesProducts, financial views

Best Practices

  • Define locations before onboarding inventory or users.
  • Prefer custom roles over sharing Admin accounts.
  • Document permission changes when creating new roles.
  • Review exchange rates on a regular schedule.

Last Updated: June 4, 2026