# User Roles

<p class="doc-lead">User Roles define what each login can see and do in Freespace ERP. Assign a role to every user; permissions are grouped by module and action.</p>

<div class="doc-toc">
<p class="doc-toc-title">On this page</p>
<div class="doc-toc-section">
<div class="doc-toc-links">
<a href="#/settings/user-role?id=overview">Overview &amp; List View</a>
<a href="#/settings/user-role?id=quick-start">Quick Start</a>
<a href="#/settings/user-role?id=permissions">Permission Matrix</a>
<a href="#/settings/user-role?id=actions">Actions</a>
<a href="#/settings/user-role?id=faq">FAQ</a>
<a href="#/settings/user-role?id=related">Related</a>
</div>
</div>
</div>

<hr class="doc-section-divider">

<h2 id="overview">Overview &amp; List View</h2>

Go to <b>Settings → User Roles</b> from the left menu.

<!-- screenshot pending -->

<b>List columns</b>

| **Column** | **Description** |
|------------|-----------------|
| Id | Role record ID. |
| Name | Role name shown when assigning users. |
| Description | Notes on intended use (e.g. Sales Executive, Accountant). |

<b>List actions</b>

| **Action** | **Description** |
|------------|-----------------|
| New | Create a role and set permissions. |
| Edit | Change name, description, or permissions. |
| Clone | Copy an existing role as a starting point. |
| Delete | Remove unused roles (multi-select supported). |

<hr class="doc-section-divider">

<h2 id="quick-start">Quick Start</h2>

<h3>1. Navigate</h3>
Go to <b>Settings → User Roles</b> and click <b>New</b> (or <b>Clone</b> from a similar role).

<h3>2. Name the role</h3>
Enter <b>Name</b> and <b>Description</b>.

<h3>3. Set permissions</h3>
On the edit screen, enable module access and actions (View, New, Edit, Delete, Approve, etc.) per area.

<h3>4. Assign to users</h3>
On <a href="#/settings/user-management">Users</a>, set each user's <b>Role</b> to this role.

<hr class="doc-section-divider">

<h2 id="permissions">Permission Matrix</h2>

Permissions are organised by module (Sales, Purchase, Inventory, Accounts, HRMS, Settings, etc.). Typical action types:

| **Permission type** | **Description** |
|-----------------------|-----------------|
| View | Open list and read records. |
| New | Create transactions or master data. |
| Edit | Change existing records. |
| Delete | Remove records where allowed. |
| Approve | Save &amp; Approve or workflow actions. |
| Reports | Access report menus under the module. |
| Settings | Access module settings screens. |

Grant only the minimum permissions needed. Use <a href="#/settings/custom-access">Custom Access</a> when a user needs extra access to specific records without a broader role change.

<hr class="doc-section-divider">

<h2 id="actions">Actions</h2>

| **Action** | **Description** |
|------------|-----------------|
| New | Creates role; opens permission editor. |
| Edit | Updates role and matrix. |
| Clone | Duplicates role with a new name. |
| Delete | Removes role if no users depend on it. |

<hr class="doc-section-divider">

<h2 id="faq">FAQ</h2>

<p><b>Can I change a user's permissions without editing the role?</b></p>
<p>Use <a href="#/settings/user-management">User Settings</a> for defaults and data filters. Module permissions come from the role; use Custom Access for record-level exceptions.</p>

<p><b>Should every employee have a unique role?</b></p>
<p>No. Create a few standard roles (Admin, Sales, Purchase, Accounts) and assign many users to the same role.</p>

<p><b>Can I clone a user role?</b></p>
<p>Use Clone on the role view to duplicate permissions, then adjust module toggles for a new department.</p>

<p><b>Why doesn't a user see a menu after role change?</b></p>
<p>The user must log out and back in, or refresh session, for role permission changes to apply fully.</p>

<p><b>What is the difference between List and View permissions?</b></p>
<p>List grants access to index screens. View, New, Edit, Delete, and Approve are separate actions on each module collection.</p>

<p><b>Do report permissions inherit from module access?</b></p>
<p>No. Enable each report explicitly under the Reports section of the role — missing report access blocks menu items and API calls.</p>

<p><b>Where are Field Sale App permissions?</b></p>
<p>Field Sale App collections appear on the role form when the module is licensed — see <a href="#/field-sale-app/settings">Field Sale App Setup</a>.</p>

<hr class="doc-section-divider">

<h2 id="related">Related Topics</h2>

<ul>
<li><a href="#/settings/user-management">Users</a></li>
<li><a href="#/settings/custom-access">Custom Access</a></li>
<li><a href="#/settings/settings">Settings hub</a></li>
</ul>
