In this section · 3 articles

Add a custom field

Add your own field to users or another kind of record: pick the entity, choose the field type, set its options and whether it's required, and check it in the live preview.

Applies to
Custom Fields 2.0 and later
Who can do this
Platform owner, Administrator
Permission
feature.cf.custom_field.create
Where
Custom Field › Custom Fields
On this page

This example adds a Department drop-down to every user. The steps are the same for any entity and field type.

Before you start

  • You need List Entity (feature.cf.entity.list), View Entity (feature.cf.entity.view), List Custom Field (feature.cf.custom_field.list) and Create Custom Field (feature.cf.custom_field.create).
  • You also need Edit Custom Field (feature.cf.custom_field.edit): without it, the Create field button isn't shown.
  • Decide the field's title carefully. Laramin makes the field's name from it, and the name can't be changed later.

Steps

  1. In the sidebar, open Custom Field › Custom Fields. The list of entities opens.

    The Custom Fields entity list, searched for User, showing the Entity, Module, Alias, Fields and Status columns, with Manage fields on the User row highlighted.
  2. Find User. Type in Search entities… to narrow the list. Then select Manage fields on its row.

    The field manager for User, listing its custom fields with ID, Title, Name, Field Type and Status columns and the Create field button, beside the Live preview of the user form.
  3. Select Create field. The Add field panel opens.

  4. In Title, enter Department. If your Laramin uses more than one language, you can enter the title in each.

  5. In Field Type, choose Select Box.

  6. Under Options, add one row per choice. In each row, enter an Option Value, which is saved, and an Option Label, which people see, for example sales and Sales. Drag rows to order them.

    The Add field panel with Title Department, Field Type Select Box, two option rows (sales / Sales and support / Support), Is Required? set to Not Required, Status Enabled and an empty Description.
  7. In Is Required?, choose Required if every user must have a department, or leave Not Required.

  8. Leave Status on Enabled.

  9. In Description, add a short hint if it helps. It appears as a tooltip beside the field.

  10. Select Save.

You see Custom Field Department Created Successfully! The field is listed with the name department, and the Live preview shows it as it will look on the user form.

What happens next

Tip: Two fields on the same entity can't share a name. If Laramin refuses your title, look in the Name column for a field that already has it, and choose another title. A field in the trash doesn't block the name.