In this section · 3 articles

Custom field types, settings and permissions

Every field type and how it appears on a form, every setting on the Add field panel, the columns of the field manager, and the permissions that control each screen.

Applies to
Custom Fields 2.0 and later
Who can do this
Platform owner, Administrator, Developer
Where
Custom Field › Custom Fields › Manage fields
On this page

Field types

Choose the type in Field Type when you add a field. It can't be changed afterwards.

Field TypeOn the formChecked when saved
Form Group LabelA heading for the fields you put inside it, as their own section or step. Nothing to fill in.
Text InputA one-line text box.Up to Max Length characters
TextareaA text box of several lines.Up to Max Length characters
Tags InputA box where people type tags. Its Options are saved but not offered as suggestions.
Email InputA text box for an email address.Must be an email address, up to Max Length characters
Date PickerA date.Must be a date
Time PickerA time.
DateTime PickerA date and time.Must be a date
Number InputA number.Must be a number
Color PickerA color.
Select BoxA drop-down list. One choice.Must be one of Options
Multiselect BoxA list where people pick several.Each must be one of Options
Radio ButtonA drop-down list. One choice.Must be one of Options
CheckboxA list where people pick several.Each must be one of Options
Image CropperAn image upload, with cropping and rotating.
File UploadA file upload.
EditorA rich text editor, with formatting.

Uploads follow your Laramin's upload settings. See File upload settings.

The Add field and Edit field panels

SettingWhat it doesShown for
TitleThe field's label on the form. You can enter it in each language. The field's name is made from it when you create the field, for example employee_id from Employee ID.Every type
Field TypeSee the table above. Locked once the field exists.Every type
LengthA width from 1 to 12. Forms don't use it: the field keeps its usual width.Every type
OptionsThe choices, one row each: Option Value is saved, Option Label is shown. Up to 190 characters each. Drag rows to order them.Select, multiselect, radio, checkbox and tags types
Default ValueA value for records that don't have one. The form doesn't show it: the box starts empty. If you leave it empty and save a new record, the record gets the default value.Every type except Form Group Label, Image Cropper, File Upload and Editor
Max LengthThe most characters allowed, from 1 to 65,535.Text Input, Textarea, Email Input
Is Required?Required means the form can't be saved without a value. Not Required is the default.Every type except Form Group Label
StatusEnabled shows the field on forms. Disabled hides it and keeps its values.Every type
DescriptionA hint shown as a tooltip beside the field. For a group, the text under its heading. You can enter it in each language.Every type
The Add field panel filled in for a Department Select Box, with Title, Field Type, Length, two Options rows (Sales and Support), Default Value, Is Required?, Status and Description.

Two fields on one entity can't have the same name. The check only looks at fields at the same level, though, so a field inside a group and one outside it can share a name. The form then shows a single box for both, inside the group, and they share one value.

The field manager

Custom Field › Custom Fields lists entities with Entity, Module, Alias, Fields and Status, a search box and Export CSV. Manage fields opens one entity.

The Custom Fields entity list, with Entity, Module, Alias, Fields and Status columns, a Manage fields button on each row, the search box and Export CSV.

The entity's field list shows ID, Title, Name, Field Type and Status. You can filter it by Field Type and Status, save views, export it, and open the Trashed view. Beside it, Live preview shows the fields as the form gets them. Select the refresh button to update it.

Permissions

In the role editor, these are under Custom Fields.

The role editor for Property CRM Admin, searched to the Custom Fields permissions, with the Custom Field module expanded to show the Custom field and Entity rows, none of their permissions granted.
PermissionLabelAllows
feature.cf.entity.listList EntityOpening Custom Field › Custom Fields and exporting the entity list.
feature.cf.entity.viewView EntityOpening an entity's field manager and its live preview.
feature.cf.custom_field.listList Custom FieldSeeing the entity's fields.
feature.cf.custom_field.viewView Custom FieldOpening one field.
feature.cf.custom_field.createCreate Custom FieldAdding fields. The Create field button also needs Edit Custom Field.
feature.cf.custom_field.editEdit Custom FieldChanging fields, and Reorder fields.
feature.cf.custom_field.deleteDelete Custom FieldMoving fields to the trash.
feature.cf.custom_field.restoreRestore Custom FieldBringing fields back from the trash.
feature.cf.custom_field.removeRemove Custom FieldDeleting fields for good.

Filling in custom fields on a record needs no Custom Fields permission, only permission to edit that record. To give these permissions, see Give someone a role.

For developers

An app signed in to the API can read an entity's field definitions, without any values, from /api/v1/customfield/schema/<alias>, for example /api/v1/customfield/schema/user. Use it to build forms that match.