> For the complete documentation index, see [llms.txt](https://docs.cloudscaff.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloudscaff.com/site-management/scaffolds.md).
# Scaffolds
## Purpose
Show all scaffolds for a site, grouped by status, so users can locate a scaffold, review its list details, and open it or create a new one.
***
## How to Access
Sites → Select a site → Scaffolds
* Visibility depends on permissions
* Buttons and actions may be hidden based on role
***
## System Preconditions
Before this tool can be used:
* Site record exists
* Scaffold records exist for the site (to display results)
* User must belong to a company
* Required permissions must be assigned
If not met, (tool hidden, empty state, etc.) if known:
* Scaffolds tab is hidden without the view permission
* Add (+) button is hidden if the site is closed or create permission is missing
* If no scaffolds exist, the list shows 0 and the table is empty
* If the site is missing, the user is redirected to the Sites list
***
## Workflow Overview
Open Scaffolds tab → Review status sections → Search or browse → Open a scaffold → Optional: add a scaffold
## Step-by-Step Workflow
### **1. View Records**
What the user does:
* Open the Scaffolds tab.
What the system displays:
* Status legend badges: Pending, Not safe for use, Safe for use
* Accordion sections with counts: Pending Scaffolds, Inactive Scaffolds, Erected Scaffolds, Dismantled Scaffolds
* Search bar: “Search by code or status”
* Table columns: Code, Description, Location, Start Date, End Date, Created By, Status
* Rows-per-page selector: 7, 10, 50, 100
Outcome:
* The user sees scaffold counts and a list grouped by status.
### **2. Create or Open a Record**
What the user does:
* Select a table row to open a scaffold, or
* Click the + button to add a scaffold (if visible).
What the system displays:
* Selecting a row opens the scaffold detail page.
* Clicking + opens the Add Scaffold modal.
{% hint style="info" %}
Learn how to [create a scaffold](/site-management/scaffolds/how-to-create-a-scaffold.md)
{% endhint %}
### **3. Complete the Action**
What the user does:
* Add a scaffold (if creating)
* Edit a scaffold
* View a scaffold
***
## Scaffold Status Lifecycle
| Status | Meaning |
| ----------------- | --------------------------------------- |
| Work In Progress | Scaffold is to be erected |
| Failed Inspection | Scaffold has failed a safety inspection |
| Handed Over | Scaffold is erected and green tagged |
| Dismantled | Scaffold has been dismantled |
***
#### Key Rules and Notes
| Rule | What it Means |
| ------------------------ | ------------------------------------------------------------------------------ |
| Scaffolds tab visibility | Shown only when the view permission is granted |
| Add button visibility | Shown only when site is not closed and create permission is granted |
| Search scope | Searches by code or status text |
| Status grouping | Scaffolds are grouped into Pending, Inactive, Erected, and Dismantled sections |
***
## Permissions Required
Permissions are evaluated per action, not globally.\
UI adapts based on role.
| Action | Required Permission |
| ---------------- | -------------------------------------------------------------------------------- |
| View scaffolds | sites-scaffolds-view |
| Create scaffolds | Any of roles-super-admin-enable, roles-site-admin-enable, sites-scaffolds-create |
***
## Troubleshooting and Common Questions
Common issues with missing tabs, empty lists, or hidden add actions are usually tied to permissions, site status, or search filters.
| Problem | Solution |
| ------------------------- | -------------------------------------------------------------- |
| Scaffolds tab not visible | Confirm the user has the view permission |
| Add (+) button missing | Confirm site is not closed and user has create permission |
| List is empty | Confirm scaffolds exist for the site or clear the search field |
***
## Common Mistakes to Avoid
* Expecting the Scaffolds tab without the view permission
* Expecting the Add button when the site is closed
* Searching with terms that do not match code or status
***
#### Related Pages and Links
{% hint style="info" %}
[Create a scaffold](/site-management/scaffolds/how-to-create-a-scaffold.md)
{% endhint %}
{% hint style="info" %}
[Edit a scaffold](/site-management/scaffolds/how-to-edit-a-scaffold.md)
{% endhint %}
{% hint style="info" %}
[Scaffold overview](/site-management/scaffolds/overview.md)
{% endhint %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.cloudscaff.com/site-management/scaffolds.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.