# Permissions Structure Overview

This page provides a complete overview of all system permissions, their associated tools, and available toggles. Use this as your reference when setting up or troubleshooting role-based access and notifications.

## System Roles

<details>

<summary><strong>Roles</strong> — System roles and their associated permissions</summary>

| Tool            | Description                                                                              | Toggles |
| --------------- | ---------------------------------------------------------------------------------------- | ------- |
| Super Admin     | Unrestricted role — grants complete access to all features, settings, and permissions.   | Enable  |
| Site Admin      | Administrative role — grants automatic access to all sites and related data.             | Enable  |
| Inventory Admin | Administrative role — grants full access to edit, adjust, and manage all inventory data. | Enable  |
| Customer        | Customer role — limits access to customer-facing features and related data only.         | Enable  |

</details>

## Enquiries

<details>

<summary><strong>Enquiries</strong> — Permissions related to managing enquiries</summary>

| Tool      | Description                                                                                            | Toggles                    |
| --------- | ------------------------------------------------------------------------------------------------------ | -------------------------- |
| Enquiries | Manage enquiries — create new records, view records, update information, and void entries when needed. | Create, View, Update, Void |

</details>

## Site Management

<details>

<summary><strong>Sites</strong> — Manage job sites and related data</summary>

| Tool                | Description                                                                                | Toggles                                                 |
| ------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| Sites               | Create, view, update, or delete job sites.                                                 | Create, View, Update, Delete                            |
| Scaffolds           | Create, view, update, or void scaffold records.                                            | Create, View, Update, Void                              |
| Scaffold Register   | View and update the complete list of scaffolds on a site.                                  | View, Update                                            |
| Map                 | View geo-located scaffolds on the site map.                                                | View                                                    |
| Inventory           | View site inventory data and generate related reports.                                     | View, Reports                                           |
| Inventory Movements | Create custom inventory movement reports and view transactions.                            | Create                                                  |
| JSP                 | Manage Job Safety Plans — create, view, update, and approve.                               | Create, View, Update, Approve                           |
| Tasks               | Create and manage task assignments, track progress, and update details.                    | Create, View, Update                                    |
| Requests            | Create, view, edit, submit, or void inventory requests from site to yard.                  | Create, View, Edit, Submit, Void                        |
| Deliveries          | Receive and manage inventory deliveries; view processed deliveries or void as needed.      | View, Receive, Void                                     |
| Returns             | Create, view, update, submit, release, or void return records.                             | Create, View, Update, Submit, Release, Void             |
| Transfers           | Manage site-to-site inventory transfers — create, view, update, receive, release, or void. | Create, View, Update, Receive, Release, Immediate, Void |
| Site Instructions   | Manage site instruction records — create, view, update, or void.                           | Create, View, Update, Void                              |

</details>

## Scaffolds

<details>

<summary><strong>Scaffolds</strong> — Manage scaffold records and compliance documents</summary>

| Tool                  | Description                                                              | Toggles                       |
| --------------------- | ------------------------------------------------------------------------ | ----------------------------- |
| Scaffold Instructions | Manage scaffold-specific instructions — create, view, update, and void.  | Create, View, Update, Void    |
| Inspections           | Generate scaffold inspection certificates — create, view, approve.       | Create, View, Approve         |
| Handovers             | Generate scaffold handover certificates — create, view, update, approve. | Create, View, Update, Approve |
| Dismantles            | Generate scaffold dismantle certificates — create, view, approve.        | Create, View, Approve         |

{% hint style="info" %}
Example: To activate the Handover Permission, navigate to Role Builder → Scaffolds Section → Tool: Handovers, and toggle Create and Approve on.
{% endhint %}

</details>

## Logs

<details>

<summary><strong>Activity Logs</strong> — View historical data and operations</summary>

| Tool          | Description                                               | Toggles |
| ------------- | --------------------------------------------------------- | ------- |
| Instructions  | View all recorded site instructions across all job sites. | View    |
| Handovers     | View all handover certificates across sites.              | View    |
| Scaffold Log  | Track scaffold activities and updates.                    | View    |
| Dismantle Log | View dismantle activity records (read-only).              | View    |

</details>

## Inventory Management

<details>

<summary><strong>Inventory</strong> — Manage company-wide inventory and movements</summary>

| Tool           | Description                                                                      | Toggles                                                 |
| -------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------- |
| Inventory      | Create, view, update, and delete inventory records.                              | Create, View, Update, Delete                            |
| Bulk Updates   | Adjust inventory quantities in bulk — create, update, approve, reverse, or void. | Create, View, Update, Approve, Reverse, Void            |
| Requests       | Process inventory requests — view, approve, or void.                             | View, Approve, Void                                     |
| Deliveries     | Manage deliveries — create, view, update, reserve, release, immediate, or void.  | Create, View, Update, Reserve, Release, Immediate, Void |
| Returns        | Manage returns — create, view, update, approve, immediate, or void.              | Create, View, Update, Approve, Immediate, Void          |
| Over Returns   | Manage over-returns — view, edit, reverse, approve, or void.                     | View, Edit, Reverse, Approve, Void                      |
| Transfers      | Manage transfers — create, view, update, receive, release, immediate, or void.   | Create, View, Update, Receive, Release, Immediate, Void |
| Yard Transfers | Move inventory between yards — create, view, update, or void.                    | Create, View, Update, Void                              |
| Site Movements | Create custom movement reports and view transactions.                            | Create                                                  |

</details>

## Reports

<details>

<summary><strong>Reports</strong> — Access and analyze operational and financial data</summary>

| Tool                      | Description                                    | Toggles |
| ------------------------- | ---------------------------------------------- | ------- |
| Inventory                 | View site inventory summaries.                 | Enable  |
| Stock Item                | View item quantities, availability, and usage. | Enable  |
| Motor                     | View motor quantities and usage.               | Enable  |
| Consumable                | View consumable item usage across sites.       | Enable  |
| Revenue                   | View financial tracking and revenue summaries. | Enable  |
| Tonnage by Location       | View tonnage usage grouped by yard.            | Enable  |
| Tonnage by Site Group     | View tonnage usage grouped by site tags.       | Enable  |
| Inventory Price List      | View inventory pricing details.                | Enable  |
| Inventory Summary         | View summarized inventory data.                | Enable  |
| Inventory Log by Site     | View inventory grouped by site.                | Enable  |
| Inventory Log by Location | View inventory grouped by yard.                | Enable  |
| Lost Inventory            | View details of missing or lost stock.         | Enable  |
| User Permissions          | View all system roles and permissions.         | Enable  |

</details>

## System Settings

<details>

<summary><strong>Settings</strong> — Manage configuration and system-level preferences</summary>

| Tool     | Description                                     | Toggles |
| -------- | ----------------------------------------------- | ------- |
| Settings | View and manage configuration logs and updates. | View    |

</details>

## Miscellaneous

<details>

<summary><strong>Miscellaneous</strong> — Additional and optional feature controls</summary>

| Tool                | Description                                        | Toggles |
| ------------------- | -------------------------------------------------- | ------- |
| Hide Weight         | Hide all weight-related information in the system. | Enable  |
| Hide Rates          | Hide all rate and cost-related information.        | Enable  |
| Manage Subscription | Manage billing, plan, and subscription settings.   | Enable  |

</details>

## System Notifications

<details>

<summary><strong>Notifications</strong> — Choose triggers to get notified about specific events and updates</summary>

| Tool                    | Description                                   | Toggles                       |
| ----------------------- | --------------------------------------------- | ----------------------------- |
| Sites                   | Key site lifecycle events.                    | Created, Updated, Closed      |
| Scaffolds               | Scaffold records created or updated.          | Created, Updated              |
| Inspection Certificates | When inspection certificates are issued.      | Created                       |
| Handover Certificates   | When handover certificates are issued.        | Created                       |
| Dismantle Certificates  | When dismantle certificates are issued.       | Created                       |
| Inventory Requests      | Status changes of inventory requests.         | Submitted, Approved, Rejected |
| Inventory Deliveries    | Inventory released or received at site.       | Released, Received            |
| Inventory Returns       | When returns are submitted or processed.      | Submitted, Processed          |
| Inventory Over Returns  | When over-returns are submitted or processed. | Submitted, Processed          |
| Inventory Transfers     | When transfers are created or received.       | Created, Received             |

You can select or unselect all toggles per section using the Select All / Unselect All buttons.

</details>

## Quick Reference Example

{% stepper %}
{% step %}

### How to activate the Handover Permission

Go to Settings → User Profiles → Edit Role → Scaffolds Section\
Find Tool: Handovers\
Description: “Generate scaffold handover certificates”\
Toggle on Create and Approve
{% endstep %}
{% endstepper %}
