Configuring Fields
How to add, configure, and manage fields in your modules
Configuring Fields
This guide shows you how to add fields to your modules and configure every setting to match your needs.
Adding a New Field
From the Module Builder
- Go to Settings > Modules and select your module
- Click the Fields tab
- Click + New field in the top right
- Select the field type
- Configure the options
- Click Save
From a Table View
- Navigate to your module's table view
- Click the + at the end of the column headers
- Choose the field type
- Configure the field settings
- The field is added to the module
Field Configuration
Every field has configuration options. Click the edit button (pencil icon) in the Actions column to open the field settings modal.
Basic Tab
Field Name
The label users see. Keep it clear and concise:
- ✅ "Deal Value", "Company Name", "Due Date"
- ❌ "DV", "Comp", "Date1"
Description
Help text that appears below the field. Use it to:
- Explain what to enter
- Provide examples
- Note any requirements
Example: "Enter the total contract value including any add-ons"
Placeholder
Hint text shown inside empty fields:
Example: "e.g., Acme Corporation"
Validation Tab
Required Field
Toggle on to require a value before saving. Use sparingly - too many required fields slow down data entry.
Only mark truly essential fields as required. You can always encourage completion without blocking saves.
Unique Values
Prevents duplicate entries. Useful for:
- Email addresses
- Invoice numbers
- SKUs
- External IDs
Validation Rules
Set custom validation:
| Rule | Example |
|---|---|
| Minimum length | At least 3 characters |
| Maximum length | No more than 50 characters |
| Pattern | Must match regex format |
| Range | Between 0 and 100 |
Default Values
Pre-populate fields for new records.
Static Default
Always the same value:
- Status: "New"
- Priority: "Medium"
- Country: "United States"
Dynamic Default
Value based on context:
- Created By: Current user
- Created Date: Today
- Owner: Current user
Calculated Default
Formula-based:
- Due Date: TODAY() + 7
- Reference Number: CONCAT("INV-", AUTO_INCREMENT())
Advanced Tab
Read-Only
Users can see but not edit. Use for:
- System-calculated values
- Import-only fields
- Audit fields
Hidden
Field exists but isn't shown in forms. Use for:
- System fields
- API-only fields
- Legacy data
Searchable
Include this field in global search results. Enable for:
- Names and titles
- Email addresses
- Important identifiers
Disable for:
- Long text fields
- Numeric data
- System fields
Configuring Select Fields
Select fields need options to choose from.
Adding Options
- Open the field settings
- Go to the Options section
- Click Add Option
- Enter the label
- Repeat for all options
Option Properties
Each option can have:
| Property | Description |
|---|---|
| Label | What users see |
| Value | Stored in database (optional) |
| Color | Visual indicator |
| Description | Tooltip on hover |
Assigning Colors
Colors help users quickly identify status:
- Click the color swatch next to an option
- Choose from the palette or enter hex code
- Use consistent colors across modules
Recommended color meanings:
- 🟢 Green - Positive (Won, Complete, Active)
- 🔵 Blue - Neutral (In Progress, Open, Pending)
- 🟡 Yellow - Warning (At Risk, Needs Review)
- 🔴 Red - Negative (Lost, Blocked, Urgent)
- ⚫ Gray - Inactive (Archived, On Hold)
Reordering Options
Drag options to change their order. Order affects:
- Dropdown list display
- Kanban column order
- Form display
Archiving Options
Don't delete options that have data - archive them:
- Click the option menu (⋯)
- Select Archive
- Option is hidden from new selections
- Existing records retain the value
Configuring Reference Fields
Reference fields link to other modules.
Setting the Target Module
- Add a Reference field
- Select Target Module
- Choose which module to link
Display Configuration
Display Field
Which field shows in the reference picker:
- Usually the primary field (name)
- Can be any text field
Secondary Info
Additional context shown in picker:
- Email for Contacts
- Website for Companies
- Status for Deals
Filtering Available Records
Limit which records can be selected:
- Enable Filter Records
- Add conditions
- Only matching records appear in picker
Example: Only show Contacts where Company = this record's Company
Relationship Configuration
Allow Multiple
- Off: One-to-one or many-to-one
- On: Many-to-many
Reverse Reference
Create a corresponding field on the target module:
- Enable Create Reverse Reference
- Name the field on the other module
- Both modules show the relationship
Configuring Formula Fields
Formula fields calculate values automatically.
Basic Setup
- Add a Formula field
- Choose Output Type (Text, Number, Date, Boolean)
- Enter your formula
- Click Validate to test
- Save the field
Formula Syntax
Field References
Use field names in curly braces:
{Deal Value} * 0.1
{First Name} & " " & {Last Name}
Operators
+ Addition
- Subtraction
* Multiplication
/ Division
& Text concatenation
Functions
Text:
CONCAT(text1, text2, ...)
UPPER(text)
LOWER(text)
LEFT(text, count)
RIGHT(text, count)
Math:
SUM(number1, number2, ...)
ROUND(number, decimals)
ABS(number)
MIN(number1, number2)
MAX(number1, number2)
Date:
TODAY()
NOW()
DATEDIFF(date1, date2)
DATEADD(date, days, "days")
YEAR(date)
MONTH(date)
Logic:
IF(condition, true_value, false_value)
AND(condition1, condition2)
OR(condition1, condition2)
ISBLANK(field)
Formula Examples
Full Name from Parts
CONCAT({First Name}, " ", {Last Name})
Commission Calculation
{Deal Value} * {Commission Rate}
Days Until Due
DATEDIFF({Due Date}, TODAY())
Status Label
IF({Probability} > 0.75, "Likely to Close", "Needs Work")
Formatted Currency
"$" & FORMAT({Deal Value}, "#,##0.00")
Field Operations
Editing Fields
- Find the field in the Fields tab
- Click the edit button (pencil icon) in the Actions column
- Make your changes
- Click Save
Reordering Fields
Use the up/down arrows in the Actions column, or edit the Sort number directly.
Deleting Fields
Deleting a field permanently removes all data in that field. Export your data first!
- Find the field in the Fields tab
- Click the delete button (trash icon) in the Actions column
- Confirm the deletion
- Data is permanently removed
Field Order and Layout
In the Module Builder
Use the Sort column in the Fields tab to set the display order. You can also use the arrow buttons in the Actions column to move fields up or down.
The sort order affects:
- Record detail layout
- Default table column order
- Form field sequence
Field Visibility Toggles
Each field has visibility toggles:
| Toggle | Description |
|---|---|
| Details Tab | Show in the main record detail view |
| Sidebar | Show in the record sidebar summary |
| List | Include in table/list views by default |
In Table Views
- Drag column headers to reorder for that specific view
- Save the view to preserve the column order
- Each view can have different column configurations
Related: Field Types Reference | Module Builder Guide | Views & Layouts