> 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/assets/register-settings.md).

# Asset register settings

{% 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, iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/assets/register-settings.md).
{% endhint %}

A register's settings: the group settings screen, with the register's asset attributes in place of tag folders. People with the settings permission change the register's details and status names, its attributes, its users, and its photo, NFC and archive options, or delete it.

![Asset register settings](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-579725662f78a5cf18965956766a42fcb371cedf%2Fregister-settings.png?alt=media)

* **Where:** web `/asset-register/:id/settings`, from the three-dot button on [Asset registers](https://docs.snapfix.com/how-the-apps-work/screens/assets/registers.md) or the gear (tooltip "Settings") on [Asset list](https://docs.snapfix.com/how-the-apps-work/screens/assets/asset-list.md) and [Asset detail](https://docs.snapfix.com/how-the-apps-work/screens/assets/asset-detail.md). iOS: the settings button on a register row (`EditBusinessMasterVC`); the asset list's menu has no settings item. Android: the settings button on a register row, and the asset list's menu (`ManageGroupActivity`).
* **Who:** web: users with the group permission `perBusSettingsScreenAccess`, checked in the page; anyone else is sent to the registers list. iOS: admins and users with the settings permission. Android: the row button opens it for admins only, the asset list menu for admins and users with the settings permission. The server's own checks on saving and deleting are looser ([`PUT`](https://docs.snapfix.com/engineering-reference/api/assets.md#put-v1appasset-regsuuid), [`DELETE`](https://docs.snapfix.com/engineering-reference/api/assets.md#delete-v1appasset-regsuuid)).
* **Feature:** [Asset registers](https://docs.snapfix.com/product/features/assets/asset-registers.md)

Details, status names and users work as in [Group settings](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-settings.md); this page covers what differs for registers.

## Layout

**Web**, top to bottom:

1. The header "Asset Register Settings" with a back button.
2. A card "Asset Register Details" with the button "Asset Register Settings", which opens the [settings drawer](#settings-drawer-web), and "Save" (on only when the form is valid and changed). Registers have no group QR button.
3. Left column: the details form (the photo, "Asset Register Name \*", "Description \*", "Purpose" and "Instructions") and "Labels" ("Define the names of status color-code", with the "Red", "Yellow" and "Green" boxes; amber is called "Yellow" here).
4. Right column: "Attributes & Labels", one card per attribute category, then the users card. The categories are "Attributes" (attributes with no category) and "Tracking" (the NFC, QR and Barcode rules, with a barcode icon). Each card has "Add Attribute" and an expand arrow; each row has a drag handle, an edit and a delete button.
5. The users card: "Users in this asset register", "Search users", "Add users to this asset register", and each member's name, email and role. Deleted profiles still appear: on the QA site two members' names start with "DEL-DEL-", and their emails have no prefix.

**iOS and Android:** the group settings screen with three tabs, "Details", "Users" and "Attributes" (iOS `BusinessPagingController`; Android adds the "Attributes" tab, `ManageAssetAttributeFragment`). The Attributes tab groups the rules under "Attributes" and each other category, with drag to reorder.

## Inputs

| Field                     | Type     | Required | Default                                                                                                                                                                            | Rules and messages                                                                                                                                                                                                                                                                                                                                                          |
| ------------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Asset Register Name"     | Text     | Yes      | The current name                                                                                                                                                                   | Up to 100 characters (the field stops there). Empty: "Save" stays off, and "Please enter the asset register name" shows once the field has been left.                                                                                                                                                                                                                       |
| "Description"             | Text     | Yes      | The current description; a new register has "New Asset"                                                                                                                            | Up to 120 characters. Empty: "Save" stays off, and "Please enter a description" shows once the field has been left.                                                                                                                                                                                                                                                         |
| "Purpose", "Instructions" | Text     | No       | The current values                                                                                                                                                                 | Up to 255 characters each.                                                                                                                                                                                                                                                                                                                                                  |
| "Red", "Yellow", "Green"  | Text     | No       | A new register has "New assets", "Assets in progress" and "Completed assets" \[[ASK-103](https://github.com/snapfix/docs/blob/main/ASK.md#ask-103-should-a-new-asset-start-green)] | Up to 255 characters each.                                                                                                                                                                                                                                                                                                                                                  |
| Photo                     | Image    | No       | The current photo                                                                                                                                                                  |                                                                                                                                                                                                                                                                                                                                                                             |
| Drawer options            | Switches | No       | Current                                                                                                                                                                            | "Allow manual NFC checks", "Block Photos from Gallery" and "Archive this asset register"; saved with the page's "Save".                                                                                                                                                                                                                                                     |
| "Attribute name"          | Text     | Yes      | Empty; the current name when editing                                                                                                                                               | Up to 100 characters. Unique in the register in any letter case, checked only against the attributes the page has loaded. Empty, taken or too long: "Save" stays off. The messages "Please enter an attribute name", "Please enter unique attribute name" and "Your input exceeds the maximum allowed length of 100 characters" show under the field once it has been left. |
| "Attribute type"          | Select   | Yes      | "Text"                                                                                                                                                                             | "Text", "Number", "Date", "Barcode", "QR", "NFC". Disabled when editing, so the type cannot change.                                                                                                                                                                                                                                                                         |
| "Mandatory"               | Switch   | No       | Off                                                                                                                                                                                | A mandatory attribute must have a value on each asset ([Asset detail](https://docs.snapfix.com/how-the-apps-work/screens/assets/asset-detail.md#inputs)).                                                                                                                                                                                                                   |

## Actions

| Action                                | Who                 | What happens                                                                                                                                                                                                                                                                                                                                                                                                                        | API                                                                                                                                                                                                                                                         |
| ------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open the page (web)                   | Settings permission | Reads the register with its attributes and its users. A register that cannot be read, or a user without the permission, is sent to the registers list.                                                                                                                                                                                                                                                                              | [`GET /v1/app/asset-regs/{uuid}`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regsuuid), [`GET /v1/app/asset-regs/{uuid}/users`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regsuuidusers) |
| "Save" (web)                          | Settings permission | Saves the details, labels and drawer options, then after 1.5 seconds goes back to the page the user came from (the asset page, a planned-task form or the registers list were all seen). Archiving takes the register out of the active list.                                                                                                                                                                                       | [`PUT /v1/app/asset-regs/{uuid}`](https://docs.snapfix.com/engineering-reference/api/assets.md#put-v1appasset-regsuuid), sent as `POST` with `_method=PUT`                                                                                                  |
| "Add Attribute"                       | Settings permission | Opens the [attribute dialog](#add-attribute-and-edit-attribute-web) for a new attribute in that category.                                                                                                                                                                                                                                                                                                                           | [`POST /v1/app/asset-regs/{uuid}/attribute-rule`](https://docs.snapfix.com/engineering-reference/api/assets.md#post-v1appasset-regsuuidattribute-rule)                                                                                                      |
| Edit an attribute                     | Settings permission | Opens the same dialog with the current values. When assets have values for the rule, the server refuses the first save and the page asks "Alert" / "There are N active asset(s) using this attribute. Changes to this attribute rule will impact with the existing assets. Are you sure to apply the changes?" with "Cancel" and "Save"; "Save" sends it again with the warning ignored. With no values it saves at once.           | [`PUT /v1/app/asset-regs/{uuid}/attribute-rule`](https://docs.snapfix.com/engineering-reference/api/assets.md#put-v1appasset-regsuuidattribute-rule)                                                                                                        |
| Reorder attributes                    | Settings permission | Drag within a category. The new order is saved at once with the warning ignored; a failed save puts the list back and shows the error.                                                                                                                                                                                                                                                                                              | [`PUT /v1/app/asset-regs/{uuid}/attribute-rule`](https://docs.snapfix.com/engineering-reference/api/assets.md#put-v1appasset-regsuuidattribute-rule) with `ignoreWarning` `1`                                                                               |
| Delete an attribute                   | Settings permission | Opens [Delete Attribute](#delete-attribute-web). The values stay on the assets \[[ASK-102](https://github.com/snapfix/docs/blob/main/ASK.md#ask-102-should-deleting-an-attribute-rule-remove-its-values-from-the-assets)].                                                                                                                                                                                                          | [`DELETE /v1/app/asset-regs/{uuid}/attribute-rule`](https://docs.snapfix.com/engineering-reference/api/assets.md#delete-v1appasset-regsuuidattribute-rule), a second time with `ignoreWarning`                                                              |
| "Delete This Asset Register" (drawer) | Settings permission | Asks "Delete Asset Register" / 'Are you sure you want to delete the "{name}" asset register?' with "Cancel" and "Delete". Then deletes the register and opens `/fix`, which shows the user's last Fix page. The button's info text says the register's tasks go too, but only the register is deleted \[[ASK-99](https://github.com/snapfix/docs/blob/main/ASK.md#ask-99-what-should-deleting-an-asset-register-do-to-its-assets)]. | [`DELETE /v1/app/asset-regs/{uuid}`](https://docs.snapfix.com/engineering-reference/api/assets.md#delete-v1appasset-regsuuid)                                                                                                                               |
| Users                                 | Settings permission | Search, add and remove members, as for groups ([Add users](https://docs.snapfix.com/how-the-apps-work/screens/groups/add-users.md)). The members answer carries each member's contact details.                                                                                                                                                                                                                                      | [`GET /v1/app/asset-regs/{uuid}/users`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regsuuidusers)                                                                                                                          |
| Attributes (apps)                     | Settings permission | iOS: "+" opens the add panel; the delete panel says how many assets use the attribute and deletes it on the device. Android: the attribute sheets (`AddOrEditAttributeBottomSheet`). Empty or taken names: "Please enter attribute name" and "Please enter unique attribute name".                                                                                                                                                  | Device copy, synced as [`?action=save_pri_businessjobattributerule`](https://docs.snapfix.com/engineering-reference/api/assets.md#post-actionsave_pri_businessjobattributerule)                                                                             |

## States

* **Loading:** web: a settings skeleton until the register loads; the saving button shows a loader.
* **Empty attributes:** the "Attributes" card with no rows and its "Add Attribute".
* **Error:** a failed save shows the server's message in an alert; a failed attribute save or reorder leaves the list as it was.
* **No permission:** web: sent to the registers list; users without the permission get the details dialog there instead ([Asset registers](https://docs.snapfix.com/how-the-apps-work/screens/assets/registers.md#asset-register-details-web)).
* **Offline (mobile):** the apps save on the device and sync later ([Shared behavior](https://docs.snapfix.com/how-the-apps-work/shared.md)).

## Dialogs and sheets

### Settings drawer (web)

Titled "Group Settings", the group wording. For registers it has only three sections: "CHECKLIST AUTOMATIONS" with "Allow manual NFC checks", "COMMUNICATION & MEDIA RESTRICTIONS" with "Block Photos from Gallery", and "GROUP CONTROL" with the switch "Archive this asset register" and the button "Delete This Asset Register". The tags, assets-and-users, checklist, tasks, report and room options of groups are left out. A changed switch is saved only with the page's "Save".

### Add Attribute and Edit Attribute (web)

Title "Add Attribute" or "Edit Attribute"; the fields "Attribute name \*", "Attribute type \*" and "Mandatory" ([Inputs](#inputs)); "Cancel" and "Save". "Save" is off while the form is invalid. Saving an unchanged attribute closes the dialog but still sends the save, so the in-use warning can appear. After a save the dialog closes after 1.5 seconds.

### Delete Attribute (web)

"Delete Attribute": "Are you sure you want to delete this attribute? This will remove the attribute from any assets that are currently using it.", with "Cancel" and "Delete". When assets use it, an alert follows: "There are N active asset(s) using this attribute. Deleting this attribute rule will impact the existing assets. Are you sure to delete the attribute?", with "Cancel" and "Delete"; it can appear a few seconds later. Both can show stray markup such as "". The count can include an asset that was deleted.

## Platform differences

| Topic          | Web                                        | iOS                          | Android                                      |
| -------------- | ------------------------------------------ | ---------------------------- | -------------------------------------------- |
| Attributes     | A column beside the details                | "Attributes" tab             | "Attributes" tab                             |
| Save           | The server, at once                        | The device, then the sync    | The device, then the sync                    |
| In-use warning | Server warning, then a second confirmation | A count in the delete panel  | Not checked                                  |
| Reorder        | Saved at once; reverts on failure          | On the device                | On the device                                |
| Drawer options | NFC, gallery photos, archive, delete       | In the group settings screen | In the group settings screen                 |
| Entry          | Registers list, asset list, asset detail   | Registers list row           | Registers list row (admins), asset list menu |


---

# 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/assets/register-settings.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.
