> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/service/field-library.md).

# Field library

The Field library holds every question you can put on an intake form, with its answer type, its checks and how its answers are protected.

{% hint style="info" %}
Fields are shared by the whole company. Flow's system fields cannot be changed. Your own fields can be edited, but their answer type is fixed, and they are archived, never deleted. <kbd>Sensitive</kbd> and the **Secret** answer type protect what staff enter.
{% endhint %}

Find it under **Settings → Intake forms → Field library**. People with **Service configuration**, or with **Service store configuration** at any store, can create and edit fields. Only **Service configuration** can mark a field sensitive or archive it. A change here reaches every form using the field, in every store.

***

## Field list

![Settings → Intake forms → Field library, showing system fields with the lock mark and a custom choice field with '3 choices, Sensitive' in Details](https://593715853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0GCVniU8V4PZKEK4axWz%2Fuploads%2FSSIe2uH6IqekCvCPwVfk%2Fservice-field-library-list.webp?alt=media)

| Field                                   | Meaning                                                                                                  |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| **Label**                               | Click it to edit one of your own fields.                                                                 |
| **Type**                                | The answer type. **Product** reads as a product search, **Priority** as single choice.                   |
| **Details**                             | How many choices, the extra check, and whether the field is <kbd>Sensitive</kbd> or <kbd>Archived</kbd>. |
| <kbd>System field</kbd>                 | Flow owns the field; it cannot be changed.                                                               |
| <kbd>Show archived</kbd>                | Includes archived fields in the list.                                                                    |
| <kbd>Archive</kbd> / <kbd>Restore</kbd> | In the row menu, for your own fields. Needs **Service configuration**.                                   |

***

## System fields

Every company has these. Labels appear in each user's language.

| Field                              | Meaning                                                                  |
| ---------------------------------- | ------------------------------------------------------------------------ |
| **Serial number**                  | Text.                                                                    |
| **IMEI**                           | Text. Flow checks that the number is a valid IMEI.                       |
| **Passcode**                       | Secret. Always sensitive.                                                |
| **Accessories**                    | Text, for what was handed in with the device.                            |
| **Shelf label**                    | Text, for where the device is stored.                                    |
| **Issue reproduced**               | Yes / no.                                                                |
| **Internal note**                  | Long text.                                                               |
| **Estimated price**, **Max price** | Number. Saved as the order's own prices.                                 |
| **Product**                        | A product search. Saved as the order's product.                          |
| **Priority**                       | A pick of the priorities. Saved as the order's priority. Never required. |

***

## New field and Edit field

![the Edit field dialog for a Text field with 'Check the answer' set to 'My own pattern' and the Ready-made patterns menu open](https://593715853-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0GCVniU8V4PZKEK4axWz%2Fuploads%2FiOUjtbNk6XUPzdz5I6BZ%2Fservice-field-library-edit-field.webp?alt=media)

| Field                                     | Meaning                                                                                                                                                                                                                                                                      |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Label**                                 | Required.                                                                                                                                                                                                                                                                    |
| **Answer type**                           | Fixed once the field is created.                                                                                                                                                                                                                                             |
| **Choices**                               | For **Single choice** and **Multiple choice**. At least one, none blank, no duplicates.                                                                                                                                                                                      |
| **Check the answer**                      | For **Text** and **Long text**: <kbd>No extra check</kbd>, <kbd>Phone number</kbd>, <kbd>E-mail address</kbd> or <kbd>My own pattern</kbd>. For **Number**: none or your own pattern. Phone numbers are checked for your company's country. Empty answers are never checked. |
| **Pattern**                               | A regular expression matching the whole answer, starting with `^` and ending with `$`. <kbd>Ready-made patterns</kbd> fills in common ones, such as an exact length.                                                                                                         |
| **Guidance**                              | Shown to whoever fills the field in.                                                                                                                                                                                                                                         |
| <kbd>Sensitive</kbd>, <kbd>Archived</kbd> | Shown only to people with **Service configuration**. <kbd>Archived</kbd> is on **Edit field** only.                                                                                                                                                                          |

***

## Answer types

| Field               | Meaning                                               |
| ------------------- | ----------------------------------------------------- |
| **Text**            | One line of text.                                     |
| **Long text**       | Several lines.                                        |
| **Number**          | A number.                                             |
| **Yes / no**        | Can have follow-up questions.                         |
| **Date**            | A date.                                               |
| **Single choice**   | One of the choices. Can have follow-up questions.     |
| **Multiple choice** | Any of the choices. Can have follow-up questions.     |
| **Secret**          | A short secret such as a lock code. Always sensitive. |

***

## Sensitive and Secret

A field works one of three ways.

| Field                   | Meaning                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Ordinary field          | The answer is kept, shows in order lists and can be searched for.                                                                                                                                                                                                                                                                                                                                             |
| <kbd>Sensitive</kbd> on | The answer is left out of order lists and search, and is shown only at the store that owns the service order or took it in. When the order reaches a status in the **Complete** or **Cancelled** state, the answer is deleted. The question stays; reopening does not bring the answer back.                                                                                                                  |
| **Secret** answer type  | Stored encrypted under the order's **Secrets**, listed by label only. Showing it is recorded on the timeline as **Secret viewed**, with who did it. With <kbd>Require a PIN code from staff</kbd> on under **Settings → General**, staff enter their own PIN first. Secrets can be opened only at the store that owns the order or took it in, and are deleted when it reaches **Complete** or **Cancelled**. |

Webhooks never carry answers, sensitive or not.

{% hint style="warning" %} <kbd>Sensitive</kbd> cannot be turned off again. Turning it on protects answers given from then on. Earlier answers can still show in order lists and at other stores until the order is finished, when they are deleted too.
{% endhint %}

A sensitive field cannot have follow-up questions. You cannot turn <kbd>Sensitive</kbd> on for a field that a follow-up question on an active form depends on; the message names the form.

***

## Changing a field that is in use

* **Label:** change it any time. Existing orders keep the label they were answered under.
* **Answer type:** fixed. Create a new field and archive the old one.
* **Choices:** you cannot remove a choice that a follow-up question on an active form depends on.
* **Check the answer:** applies to new answers; given answers are not checked again.
* **Archive:** the field stays on forms that have it, marked <kbd>Archived</kbd>, and its answers stay. It cannot be added to more forms until you <kbd>Restore</kbd> it.
* **Delete:** fields are never deleted.


---

# 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.flowretail.com/docs/service/field-library.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.
