Field Attributes

A list of attributes that can be set on fields. You set them when creating or editing a field on the Schema screen. Attributes determine how a field is displayed and the rules for the values that can be entered. The create and edit dialog has three tabs, Settings, Validation, and Default value, and each attribute has a fixed tab where it is set and a fixed set of field types it can be set on.

Attribute	What it determines	Tab	Field types it can be set on
Display name	The name used to show the field on screen	Settings	All field types
Field Key	The key that identifies the field	Settings	All field types
Description	A supplementary note on the field’s purpose	Settings	All field types
Support multiple values	Whether the field can hold more than one value	Settings	Text, TextArea, Markdown text, Int, Float, Boolean, Check Box, Option, Tag, Date, URL, Asset, Group, Geometry Object, Geometry Editor
Make field required	Whether the field can be saved while empty	Validation	Text, TextArea, Markdown text, Int, Float, Option, Tag, Date, URL, Asset, Reference, Geometry Object, Geometry Editor
Set field as unique	Whether the same value can be held more than once	Validation	Text, TextArea, Markdown text, Int, Float, Option, Tag, Date, URL, Asset, Reference, Geometry Object, Geometry Editor
Use as title	Whether to use the field as the item’s title	Settings	Text, TextArea, Markdown text
Set maximum length	The upper limit on the number of characters that can be entered	Validation	Text, TextArea, Markdown text
Set minimum value	The lower limit on the number that can be entered	Validation	Int, Float
Set maximum value	The upper limit on the number that can be entered	Validation	Int, Float
Set default value	The initial value that is prefilled when an item is created	Default value	Text, TextArea, Markdown text, Int, Float, Boolean, Check Box, Option, Tag, Date, URL, Asset, Geometry Object, Geometry Editor

Tag and Check Box are field types available for metadata. For details, see Metadata.

Display name

The field’s display name. Used to show the field on screens and in lists. Required.

Field Key

The key that identifies the field. It must be 1 to 32 characters and unique within the same schema. You can use alphanumeric characters, underscores, and dashes.

Description

A description of the field. Set to supplement the field’s purpose. Maximum 1000 characters.

Support multiple values

An attribute that lets a field hold multiple values in list form, instead of a single value.

Make field required

When this attribute is set, an item cannot be saved while the value is left empty.

Set field as unique

An attribute that prevents more than one item from holding the same value. A value can be used by only one item in that field. On a Reference field, you can set it for a one-way reference. You cannot set it for a two-way reference.

Use as title

An attribute that uses the field as the item’s title. Only one field per schema can be set as the title. You can set one among an item’s fields and one among a Group’s fields. You cannot set it on Metadata fields.

Set maximum length

The upper limit on the number of characters that can be entered. Set to a value of 1 or greater.

Set minimum value

The lower limit on the number that can be entered. The minimum value must be less than or equal to the maximum value.

Set maximum value

The upper limit on the number that can be entered. The maximum value must be greater than or equal to the minimum value.

Set default value

The initial value that is prefilled when an item is created.