Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.perscom.io/llms.txt

Use this file to discover all available pages before exploring further.

Custom fields let you capture data beyond the built-in fields in PERSCOM. Add fields to user profiles, personnel records, and forms to track information specific to your organization.

​
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

  1. In the sidebar, select Settings > Resources > Fields.
  2. Select New field.
  3. 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)
  4. Configure optional settings in the Details, Validation, and Visibility tabs.
  5. Select Create.

​
Field Types

TypeDescription
TextSingle-line text input
TextareaMulti-line text input
EmailEmail address with validation
NumberNumeric input
PasswordMasked password input
CodeCode 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:
  1. Select Array as the options type.
  2. 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:
  1. Select Resource as the options type.
  2. Choose a resource from the dropdown:
    • Awards, Calendars, Documents, Events
    • Forms, Groups, Positions, Qualifications
    • Ranks, Slots, Specialties, Statuses
    • Tasks, Units, Users
The dropdown automatically updates when resources are added or removed.

​
Field Settings

​
Details Tab

SettingDescription
PlaceholderText displayed when the field is empty
HelpHelper text displayed below the field
True ValueLabel for true state (boolean fields only)
False ValueLabel for false state (boolean fields only)

​
Validation Tab

SettingDescription
RulesLaravel validation rules (pipe-delimited)
RequiredField must be filled out
ReadonlyField displays value but cannot be edited
Common validation rules:
  • min:3 — Minimum 3 characters
  • max:100 — Maximum 100 characters
  • regex:/^[A-Z]+$/ — Must match pattern
  • url — Must be a valid URL
  • digits:5 — Must be exactly 5 digits
For a complete list, see the Laravel validation documentation.

​
Visibility Tab

SettingDescription
HiddenField only visible to users with edit permissions

​
Add Fields To Users

You can attach custom fields to user profiles in two ways: globally for all users or individually per user.

​
Global User Fields

Apply custom fields to all user accounts automatically:
  1. Navigate to Settings > Dashboard > Fields.
  2. Select the Users tab.
  3. Select the custom fields to include on all user profiles.
  4. Select Save.
The selected fields appear on all user profiles. When new user accounts are created, these fields are automatically attached.

​
Individual User Fields

Attach custom fields to a specific user’s profile:
  1. Navigate to a user’s profile and select Edit.
  2. Select the Fields tab.
  3. Select Add field and choose the fields to attach.
Custom field data appears on the user’s profile and can be edited by users with appropriate permissions.

​
Add Fields To Forms

Build custom forms using your fields:
  1. Navigate to Forms and select a form.
  2. Select the Fields tab.
  3. Select Add field and choose the fields to include.
  4. Drag fields to reorder them.
When users submit the form, their responses are saved with the submission.

​
Add Fields To Records

Apply custom fields globally to all records of a specific type:
  1. Navigate to Settings > Dashboard > Fields.
  2. Select the record type tab (Assignment, Award, Combat, etc.).
  3. Select the custom fields to include.
  4. Select Save.
The selected fields appear on all record forms of that type.

​
API Access

Custom field data is included in API responses at the root level, keyed by the field’s slug. 
{
  "data": {
    "id": 1,
    "name": "John Doe",
    "certification_number": "ABC123",
    "emergency_contact": "Jane Doe"
  }
}

​
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