Use Cases
- User profiles — Track additional personnel data like certifications, specializations, or emergency contacts
- Personnel records — Add context to assignment, award, or training records with custom metadata
- Forms — Build application forms, surveys, or request forms with custom input fields
Create A Custom Field
- In the sidebar, select Settings > Resources > Fields.
- Select New field.
- Configure the field settings:
- Name — The label displayed to users
- Slug — A unique identifier used when saving data (auto-generated from name)
- Type — The input type (see Field Types)
- Configure optional settings in the Details, Validation, and Visibility tabs.
- Select Create.
Field Types
- Text Input
- Selection
- Date & Time
- Other
- Components
| Type | Description |
|---|---|
| Text | Single-line text input |
| Textarea | Multi-line text input |
| Email address with validation | |
| Number | Numeric input |
| Password | Masked password input |
| Code | Code editor with syntax highlighting |
Configure Select Options
When using the Select field type, you can populate options from two sources:Custom Options
Define a static list of key-value pairs:- Select Array as the options type.
- Add options using the key-value editor.
- Key — The value stored in the database
- Value — The label displayed to users
Resource Options
Dynamically populate options from PERSCOM resources:- Select Resource as the options type.
- Choose a resource from the dropdown:
- Awards, Calendars, Documents, Events
- Forms, Groups, Positions, Qualifications
- Ranks, Slots, Specialties, Statuses
- Tasks, Units, Users
Field Settings
Details Tab
| Setting | Description |
|---|---|
| Placeholder | Text displayed when the field is empty |
| Help | Helper text displayed below the field |
| True Value | Label for true state (boolean fields only) |
| False Value | Label for false state (boolean fields only) |
Validation Tab
| Setting | Description |
|---|---|
| Rules | Laravel validation rules (pipe-delimited) |
| Required | Field must be filled out |
| Readonly | Field displays value but cannot be edited |
min:3— Minimum 3 charactersmax:100— Maximum 100 charactersregex:/^[A-Z]+$/— Must match patternurl— Must be a valid URLdigits:5— Must be exactly 5 digits
Visibility Tab
| Setting | Description |
|---|---|
| Hidden | Field only visible to users with edit permissions |
Add Fields To Users
Attach custom fields directly to user profiles:- Navigate to a user’s profile and select Edit.
- Select the Fields tab.
- Select Add field and choose the fields to attach.
Add Fields To Forms
Build custom forms using your fields:- Navigate to Forms and select a form.
- Select the Fields tab.
- Select Add field and choose the fields to include.
- Drag fields to reorder them.
Add Fields To Records
Apply custom fields globally to all records of a specific type:- Navigate to Settings > Dashboard > Fields.
- Select the record type tab (Assignment, Award, Combat, etc.).
- Select the custom fields to include.
- Select Save.
API Access
Custom field data is included in API responses at the root level, keyed by the field’s slug.Best Practices
- Use descriptive names — Choose clear field names that indicate what data to enter
- Set appropriate types — Use email type for emails, number for numeric data, etc.
- Add help text — Guide users on expected input format or requirements
- Limit required fields — Only require fields that are truly essential
- Use slugs consistently — Keep slugs lowercase with underscores for API compatibility