> For the complete documentation index, see [llms.txt](https://documentation.ardoq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.ardoq.com/data-model/fields.md). # Fields Fields are user-defined metadata that qualifies components and references. A field is metadata that can be added to a component or reference to provide additional information. For example, you can add a Version Number field to an Application component to store details about the version that the application is currently on. Ardoq metamodels come with metamodel-specific fields and references, but custom fields and references can be added as well. Fields can be searched and filtered to help you narrow down your selection of components or references. ## When to Use Fields A field is usually used to qualify a component or provide additional context for it. For example, an Application component might have a Service Level Agreement field or a Life Cycle field. In other cases, a field will not be enough to describe the complexities of a component. In that case, it is better to create a new component with its own descriptive fields and then create a relationship between the two components. For example, if you have a Server component, adding a field called Operating System will not be enough to describe precisely which variant of an Operating System is running on the server. That is, the Operating System has its own version, life cycle, business criticality and so on — too many details to easily capture in a field or even a number of fields. In this situation, we recommend creating an Operating System component with its own relevant fields and then connecting it to the Server component through a reference like **Runs on**. ## Creating New Fields All components have a number of built-in fields, such as type and last modified, but can also be extended to meet your modelling needs. ### Metamodel Editor To create a new field globally: {% stepper %} {% step %} ### Navigate to the Metamodel Editor Click your organization name in the top-left corner and select **Admin** > **Metamodel** then the **Fields** tab. {% endstep %} {% step %} ### Create and Apply Field Click the **Create field** button, enter a field label and give the field a type, then click **Create**. Once the field is created, you'll be prompted to extend your field definition with an optional default value and description. For the field to become part of a component or reference, it must be applied to that component or reference type. Under **Applied types**, use the component or reference types dropdown to select your field and click **Save** to apply it. {% endstep %} {% endstepper %} ### Integrations You can create fields in bulk when importing data using an integration. Columns with a field mapping will create that field if it doesn't already exist in your metamodel and automatically apply it to the component type being created.
## Field Groups Field groups organize fields into labelled sections that are helpful for grouping conceptually similar fields together for improved readability. For example, a **Cost** group can bundle Total Cost, CAPEX, OPEX, and other cost fields together instead of spreading them out alphabetically in a long list of fields.

An example of a field grouping built around vulnerability details.

### Creating and Adding Field Groups Field groups can be created in the Metamodel Editor under the **Field groups** tab. Field groups can then be applied to fields (in the **Fields** tab) in the dropdown under the **Groups** heading. Click **Save** to finalize your addition of the field group.
You will need to apply the field group to every field that you wish to be part of that group. {% hint style="info" %} You can create a new field group directly from the **Groups** dropdown by entering a new field name and clicking the **Create** button. {% endhint %} ## Field Types Use field types to easily store different types of data about your components and references. | Field type | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Text | Stores alphanumeric characters of variable length. | | Number | Stores numerical values | | Email | Stores email addresses | | Text paragraph | Stores longer pieces of text, often used for notes or descriptions | | Date time | Stores a single date (e.g. creation date) | | Checkbox | Stores `true` (Checked), `false` (Unchecked), or `null` (Not set) values. **Note on Resetting:** While clicking a checkbox in Data Inventory toggles between Checked and Unchecked, you can reset a checkbox back to "Not set" using any of these methods: **Grid Editor (UI):** Right-click the checkbox cell and select **"Change to not set state"**. **Excel Import:** Leave the cell blank during import. [**REST API**](https://developer.ardoq.com/public-api/#tag/Components/paths/~1api~1v2~1components~1%7Bid%7D/patch)**:** Send a `PATCH` request setting the field value to `null`. | | List | Allows users to select from a predefined list of options. | | Select multiple list | Allows users to select multiple options from a predefined list. | | User | References a user within the Ardoq platform. | | URL | Stores web addresses | | Date range | Stores a start and end time | | Calculated field | Stores values derived from multiple inputs. E.g. Calculates and stores the health score derived from adding up the business and technical fit scores of applications. [Learn more about calculated fields in this article.](https://help.ardoq.com/en/articles/44214-calculated-fields) | | File | Stores a URL linking to a file and can be used to preview the file within Ardoq. Currently limited to the SAP Signavio integration. | ### Number Field Formatting Number fields are displayed according to the user's selected locale. In addition, the number field can either be formatted as a plain number or as a currency. When creating or editing a number field, there is a drop-down where the formatting can be defined. ## FAQ
Are there any reserved field types? Yes, Ardoq has several reserved field names within Ardoq that cannot be used to name your custom fields. They are listed in table below for your reference: | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

description
\_order
last-updated
\_id
children
mustBeSaved
color
parent
ardoq-entity-type
lastModifiedByName
name
createdByEmail
type
created
rootWorkspace
source
displayText
typeId
returnValue
componentTypeId

|

isPublic
targetWorkspace
created-by
last-modified-by
id
shape
order
image
origin
lastModifiedByEmail
target
component-key
version
\_version
ardoq
createdByName
model
icon
lock
referenceTypeId

| Attempting to use a reserved field name will give you an **Invalid field name** error.