> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/compliance/systems.md).

# Systems

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: web. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/compliance/systems.md).
{% endhint %}

The site's compliance systems, grouped by system type. Admins add, rename, reorder and delete system types, add and reorder systems, and open a system.

![Systems](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-dcd8aac607a73c74d56a20a31558ffe0b8d29063%2Fsystems.png?alt=media)

* **Where:** web `/comply`, "Systems" tab. The tab reads "Systems (n)" while it is open, where n is the number of system types.
* **Who:** site admins (role "Admin"); see [Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/compliance/dashboard.md#getting-here). In the API, any member of the site can read the type and system lists and reorder system types \[[ASK-112](https://github.com/snapfix/docs/blob/main/ASK.md#ask-112-which-comply-reads-should-members-who-are-not-admins-get)].
* **Feature:** [Compliance systems](https://docs.snapfix.com/product/features/compliance/compliance-systems.md)

A site with no system types gets the default set when this tab or the Dashboard opens: two types, "Company Certificates" and "Fire Safety", with their systems ([defaults](https://docs.snapfix.com/engineering-reference/api/compliance.md#post-v1appparentscomply-defaults)).

## Layout

1. **Header:** "Systems", a search box labelled "Search", and a "+" button with no label, which adds a system type.
2. **Type cards**, one per system type in the saved order, all collapsed when the page opens. Each card header shows:
   * the type's name;
   * when the type has systems, a status icon (red when any system is red, green when all are green, amber otherwise) and the number of systems;
   * a pencil that renames the type, a "⋯" menu with "Add System" and "Delete Systems Type", and an arrow that opens or closes the card.
3. **System rows**, inside an open card, in the saved order. Each row has a drag handle, the system's name, four icons that light up when the system has assets, a contractor, assigned users or documents, a frequency icon whose tooltip is the frequency, and a status dot.

A type with no systems holds one blank draft row; opening its card puts the cursor in that row's name box. While a draft row is open, "Add System" in the menu is disabled.

## Inputs

| Field            | Type | Required | Default              | Rules and messages                                                                                                                                                                                                                                                                                                                                                                                    |
| ---------------- | ---- | -------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| System type name | Text | Yes      | Empty for a new type | Up to 255 characters. Saved on Enter or when the box loses focus. The page sends an empty name too. The API refuses an empty name, and a name another type of the site has: `422` "The name has already been taken." for a new type, `400` "The system type already exists" for a rename. The page shows no message: a new card stays open with the typed name, and a renamed card keeps its old name |
| System name      | Text | Yes      | Empty                | Trimmed. Saved on Enter or when the box loses focus. An empty name discards the new row with no message                                                                                                                                                                                                                                                                                               |
| Search           | Text | No       | Empty                | Filters about a second after the last key press, with no request. Shows the types whose name matches and the types that hold a matching system; inside a type, only the matching systems show, and a type with a match opens                                                                                                                                                                          |

## Actions

| Action                 | Who         | What happens                                                                                                                                                                                                                                                                                                                                | API                                                                                                                                                                                                                                                                                                                                                                                                 |
| ---------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open the tab           | Site admins | Disables every Comply tab, loads the type list, then each type card loads its own systems, one request per type. If the type list is empty, creates the defaults and loads again                                                                                                                                                            | [`GET /v1/app/comply/system-type`](https://docs.snapfix.com/engineering-reference/api/compliance.md#get-v1appcomplysystem-type), [`GET /v1/app/comply/system`](https://docs.snapfix.com/engineering-reference/api/compliance.md#get-v1appcomplysystem), [`POST /v1/app/parents/comply-defaults`](https://docs.snapfix.com/engineering-reference/api/compliance.md#post-v1appparentscomply-defaults) |
| "+"                    | Site admins | Adds a new card at the top with its name box in focus. One new card at a time; its trash icon discards it                                                                                                                                                                                                                                   | -                                                                                                                                                                                                                                                                                                                                                                                                   |
| Save a new type name   | Site admins | Creates the type with sort order 0, then reloads the list                                                                                                                                                                                                                                                                                   | [`POST /v1/app/comply/system-type`](https://docs.snapfix.com/engineering-reference/api/compliance.md#post-v1appcomplysystem-type)                                                                                                                                                                                                                                                                   |
| Pencil on a type       | Site admins | Edits the name in place; Enter or leaving the box saves it, then the list reloads                                                                                                                                                                                                                                                           | [`PUT /v1/app/comply/system-type/{uuid}`](https://docs.snapfix.com/engineering-reference/api/compliance.md#put-v1appcomplysystem-typeuuid)                                                                                                                                                                                                                                                          |
| Drag a type            | Site admins | Saves the new order at once, in steps of 1000, then reloads                                                                                                                                                                                                                                                                                 | [`POST /v1/app/comply/system-type/sort`](https://docs.snapfix.com/engineering-reference/api/compliance.md#post-v1appcomplysystem-typesort)                                                                                                                                                                                                                                                          |
| "Add System"           | Site admins | Opens the card and adds a draft row at the end, with its name box in focus. The trash icon on the draft discards it                                                                                                                                                                                                                         | -                                                                                                                                                                                                                                                                                                                                                                                                   |
| Save a new system name | Site admins | Creates the system and opens [System detail](https://docs.snapfix.com/how-the-apps-work/screens/compliance/system-detail.md) with the type in the address. New systems start with the frequency "None" \[[ASK-109](https://github.com/snapfix/docs/blob/main/ASK.md#ask-109-what-should-frequency-do-and-what-should-new-items-start-with)] | [`POST /v1/app/comply/system`](https://docs.snapfix.com/engineering-reference/api/compliance.md#post-v1appcomplysystem)                                                                                                                                                                                                                                                                             |
| Click a system row     | Site admins | Opens [System detail](https://docs.snapfix.com/how-the-apps-work/screens/compliance/system-detail.md) with the type's name and ID in the address (`?type=…&id=…`). A system is renamed there, not here                                                                                                                                      | -                                                                                                                                                                                                                                                                                                                                                                                                   |
| Drag a system          | Site admins | Saves the new order inside its type at once, in steps of 1000, then reloads                                                                                                                                                                                                                                                                 | [`POST /v1/app/comply/system/sort`](https://docs.snapfix.com/engineering-reference/api/compliance.md#post-v1appcomplysystemsort)                                                                                                                                                                                                                                                                    |
| "Delete Systems Type"  | Site admins | Opens [Delete Systems Type](#delete-systems-type). Confirming deletes the type and reloads the list                                                                                                                                                                                                                                         | [`DELETE /v1/app/comply/system-type/{uuid}`](https://docs.snapfix.com/engineering-reference/api/compliance.md#delete-v1appcomplysystem-typeuuid)                                                                                                                                                                                                                                                    |
| Open or close a card   | Site admins | Shows or hides the type's systems. No request                                                                                                                                                                                                                                                                                               | -                                                                                                                                                                                                                                                                                                                                                                                                   |

## States

* **Loading:** every Comply tab is disabled until the type list arrives.
* **Empty:** a site with no types gets the default set. If the defaults call answers success without creating any, the page asks again after each empty answer.
* **Error:** the type list and every type call skip the shared error alert, and the page handles no error, so a failed create or rename shows nothing. A failed type list leaves every Comply tab disabled until the page is reloaded.
* **No permission:** a non-admin never reaches the page. The API refuses writes from a non-admin with "Access denied".
* **Offline (mobile):** not applicable (web only).

## Dialogs and sheets

### Delete Systems Type

Title "Delete Systems Type". The message reads "Deleting this System Type will permanently remove all related Systems and the data from their associated tasks and contractors. Do you want to continue?". Buttons "Cancel" and "DELETE".

The API deletes only the type. Its systems keep their documents and their task and contractor links, drop out of every list, and answer `404` on their own page, so neither the web nor the API can remove them afterwards. A system left this way on the QA site needs a person to remove it \[[ASK-108](https://github.com/snapfix/docs/blob/main/ASK.md#ask-108-remove-the-test-system-left-on-the-qa-site)].

## Platform differences

Web only. The apps cannot add, rename or delete system types or systems. They can link a compliance system to a task ([Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#compliance-system)) and pick one for a planned task ([Planned task](https://docs.snapfix.com/how-the-apps-work/screens/planner/planned-task.md)).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/how-the-apps-work/screens/compliance/systems.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
