Configurable Fields

Overview

Configurable fields allow you to customize MartialFlow to capture and manage information specific to your school's needs. This guide covers creating custom fields, field types, validation rules, and managing field data effectively.

Prerequisites

• Administrative access to system configuration
• Understanding of your school's unique data requirements
• Knowledge of data types and validation concepts
• Familiarity with form design principles

Understanding Configurable Fields

Field Types Available

Basic Field Types

• Text Fields - Single-line text input for names, addresses
• Textarea Fields - Multi-line text for notes and descriptions
• Number Fields - Numeric input with validation
• Date Fields - Date selection with calendar picker
• Time Fields - Time selection with time picker

Selection Field Types

• Dropdown Lists - Single selection from predefined options
• Radio Buttons - Single selection with visible options
• Checkboxes - Multiple selection options
• Multi-Select Lists - Multiple selections from dropdown

Advanced Field Types

• Email Fields - Email address with validation
• Phone Fields - Phone number with formatting
• URL Fields - Website links with validation
• File Upload - Document and image attachments

Field Applications

Student Information Fields

1. Personal Details

   • Emergency contact relationships
   • Dietary restrictions and allergies
   • Medical conditions and medications
   • Special accommodation needs

2. Martial Arts Background

   • Previous martial arts experience
   • Other sports and activities
   • Training goals and objectives
   • Preferred training times

Family Information Fields

1. Household Details

   • Family composition
   • Transportation arrangements
   • Communication preferences
   • Cultural or religious considerations

2. Business Information

   • Employer information
   • Work schedules
   • Military service
   • Professional background

Creating Custom Fields

Accessing Field Configuration

Navigation to Field Management

1. Access Custom Fields

   • Navigate to Settings → Configuration → Custom Fields
   • Select entity type (Student, Customer, Class, etc.)
   • Click "Add New Field"
   • Choose field category

2. Field Management Interface

   • Field List - View all existing custom fields
   • Field Editor - Create and modify fields
   • Preview Mode - See how fields appear to users
   • Field Analytics - Usage and completion statistics

Field Creation Process

Basic Field Configuration

1. Field Information

   • Field Name - Internal system name (no spaces)
   • Display Label - Text shown to users
   • Field Type - Select appropriate field type
   • Category - Group fields logically

2. Field Properties

   • Required Field - Make field mandatory
   • Default Value - Pre-populate with default
   • Help Text - Guidance for users
   • Placeholder Text - Example text in field

Advanced Field Settings

1. Validation Rules

   // Example validation for emergency contact
   {
     "required": true,
     "minLength": 2,
     "maxLength": 50,
     "pattern": "^[a-zA-Z\\s]+$",
     "errorMessage": "Please enter a valid name"
   }

2. Display Options

   • Field Order - Position in form
   • Field Width - Full width or partial
   • Conditional Display - Show based on other fields
   • Section Grouping - Organize fields in sections

Field Type Configuration

Text Field Setup

1. Text Field Properties

   • Maximum Length - Character limit
   • Minimum Length - Required character count
   • Character Validation - Letters, numbers, special chars
   • Format Validation - Specific format requirements

2. Text Field Examples

   Field: Emergency Contact Name
   Type: Text
   Required: Yes
   Max Length: 50
   Validation: Letters and spaces only
   Help Text: "Enter the full name of emergency contact"

Number Field Setup

1. Number Field Properties

   • Minimum Value - Lowest acceptable number
   • Maximum Value - Highest acceptable number
   • Decimal Places - Number precision
   • Unit Display - Show units (years, pounds, etc.)

2. Number Field Examples

   Field: Student Age at Enrollment
   Type: Number
   Required: Yes
   Min Value: 3
   Max Value: 99
   Help Text: "Age when student first enrolled"

Date Field Setup

1. Date Field Properties

   • Date Format - MM/DD/YYYY, DD/MM/YYYY, etc.
   • Minimum Date - Earliest selectable date
   • Maximum Date - Latest selectable date
   • Default Date - Pre-selected date

2. Date Field Examples

   Field: Previous Injury Date
   Type: Date
   Required: No
   Max Date: Today
   Help Text: "Date of most recent martial arts injury"

Dropdown Field Setup

1. Dropdown Configuration

   • Option List - Available selection choices
   • Default Selection - Pre-selected option
   • Allow Other - Custom text entry option
   • Sort Order - Alphabetical or custom order

2. Dropdown Examples

   Field: Martial Arts Experience Level
   Type: Dropdown
   Options:
   - No Experience
   - Beginner (under 1 year)
   - Intermediate (1-3 years)
   - Advanced (3+ years)
   - Expert (5+ years)
   Default: No Experience

Field Organization

Field Categories

Student Information Categories

1. Personal Information

   • Basic demographic data
   • Physical characteristics
   • Health and medical information
   • Emergency contact details

2. Academic Information

   • School and grade level
   • Academic achievements
   • Learning preferences
   • Special educational needs

3. Athletic Information

   • Sports participation
   • Physical abilities
   • Injury history
   • Fitness level

Family Information Categories

1. Household Composition

   • Family members
   • Living arrangements
   • Custody information
   • Sibling relationships

2. Lifestyle Information

   • Work schedules
   • Transportation
   • Religious observances
   • Cultural background

Field Sections

Section Organization

1. Create Field Sections

   • Section Name - Descriptive section title
   • Section Description - Purpose and contents
   • Section Order - Position in form
   • Collapsible - Allow section collapse

2. Section Examples

   Section: Emergency Information
   Fields:
   - Emergency Contact 1 Name
   - Emergency Contact 1 Phone
   - Emergency Contact 1 Relationship
   - Emergency Contact 2 Name
   - Emergency Contact 2 Phone
   - Medical Conditions
   - Allergies
   - Current Medications

Field Grouping

1. Logical Grouping

   • Group related fields together
   • Use consistent naming conventions
   • Order fields logically
   • Minimize cognitive load

2. Visual Organization

   • Use section headers
   • Apply consistent spacing
   • Highlight required fields
   • Provide clear instructions

Field Validation

Validation Types

Format Validation

1. Text Pattern Validation

   // Phone number validation
   pattern: "^\\+?[1-9]\\d{1,14}$"
   
   // Email validation
   pattern: "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
   
   // Name validation (letters and spaces)
   pattern: "^[a-zA-Z\\s]+$"

2. Number Range Validation

   // Age validation
   {
     "min": 3,
     "max": 99,
     "errorMessage": "Age must be between 3 and 99"
   }
   
   // Weight validation
   {
     "min": 20,
     "max": 500,
     "unit": "pounds"
   }

Business Logic Validation

1. Conditional Requirements

   // Require parent signature for minors
   if (student.age < 18) {
     parentSignature.required = true;
   }
   
   // Require medical clearance for certain conditions
   if (medicalConditions.includes("heart condition")) {
     medicalClearance.required = true;
   }

2. Cross-Field Validation

   // Emergency contact can't be same as student
   if (emergencyContact.phone === student.phone) {
     return "Emergency contact must be different from student";
   }

Error Handling

Validation Messages

1. Clear Error Messages

   • Specific problem description
   • Suggested correction
   • Examples of valid input
   • User-friendly language

2. Error Message Examples

   Instead of: "Invalid input"
   Use: "Phone number must include area code (e.g., 555-123-4567)"
   
   Instead of: "Required field"
   Use: "Emergency contact name is required for student safety"

Error Prevention

1. Input Assistance

   • Format examples in placeholder text
   • Real-time validation feedback
   • Auto-formatting where possible
   • Clear field labels and help text

2. Progressive Validation

   • Validate fields as user types
   • Show success indicators
   • Provide immediate feedback
   • Prevent form submission errors

Field Data Management

Data Collection

Form Integration

1. Enrollment Forms

   • Include custom fields in registration
   • Make fields visible during enrollment
   • Require completion before submission
   • Save incomplete progress

2. Profile Updates

   • Allow family updates to custom fields
   • Notify when updates are needed
   • Track field completion rates
   • Send reminders for missing information

Data Entry Workflows

1. Staff Data Entry

   • Provide staff training on custom fields
   • Create data entry guidelines
   • Implement quality control checks
   • Monitor data accuracy

2. Bulk Data Import

   • Map custom fields in import process
   • Validate data during import
   • Handle import errors gracefully
   • Provide import success reports

Data Utilization

Reporting and Analytics

1. Custom Field Reporting

   • Include fields in student reports
   • Create custom field analytics
   • Track field completion rates
   • Analyze field usage patterns

2. Segmentation and Filtering

   • Use custom fields for student grouping
   • Create targeted communications
   • Filter students by custom criteria
   • Build custom student lists

Integration Usage

1. Communication Personalization

   • Use custom fields in email templates
   • Personalize messages with field data
   • Create targeted campaigns
   • Improve communication relevance

2. Class Placement

   • Use fields for class recommendations
   • Consider physical requirements
   • Account for experience levels
   • Match students appropriately

Field Maintenance

Field Lifecycle Management

Field Updates

1. Modifying Existing Fields

   • Change field labels and help text
   • Update validation rules
   • Modify dropdown options
   • Adjust field requirements

2. Field Versioning

   • Track field changes over time
   • Maintain data consistency
   • Handle legacy data appropriately
   • Document field modifications

Field Retirement

1. Deprecating Fields

   • Remove unused fields
   • Archive historical data
   • Notify users of changes
   • Provide migration paths

2. Data Migration

   • Move data to new fields
   • Transform data formats
   • Preserve data integrity
   • Validate migration results

Data Quality Management

Data Validation

1. Regular Data Audits

   • Check for incomplete fields
   • Identify invalid data
   • Monitor data quality trends
   • Implement correction procedures

2. Data Cleansing

   • Standardize data formats
   • Remove duplicate entries
   • Correct invalid data
   • Update outdated information

Field Performance

1. Usage Analytics

   • Track field completion rates
   • Monitor field abandonment
   • Analyze user behavior
   • Optimize field design

2. Performance Optimization

   • Simplify complex fields
   • Reduce required fields
   • Improve field usability
   • Enhance user experience

Best Practices

Field Design

1. User-Centered Design - Design fields from user perspective
2. Clear Labeling - Use descriptive, unambiguous labels
3. Logical Organization - Group related fields together
4. Minimal Requirements - Only require truly necessary information
5. Progressive Disclosure - Show advanced fields only when needed

Data Management

1. Data Privacy - Collect only necessary information
2. Data Security - Protect sensitive custom field data
3. Data Accuracy - Implement validation and verification
4. Data Retention - Follow appropriate retention policies
5. Data Access - Control who can view custom field data

Technical Implementation

1. Performance Consideration - Optimize field loading and validation
2. Mobile Optimization - Ensure fields work on mobile devices
3. Accessibility - Make fields accessible to all users
4. Integration Planning - Consider how fields integrate with other systems
5. Testing - Thoroughly test fields before deployment

Common Field Examples

Medical Information Fields

Field: Allergies
Type: Textarea
Required: No
Help Text: "List any known allergies (food, medication, environmental)"

Field: Current Medications
Type: Textarea
Required: No
Help Text: "List all current medications and dosages"

Field: Medical Conditions
Type: Multi-Select
Options: Asthma, Diabetes, Heart Condition, Epilepsy, Other
Required: No

Emergency Contact Fields

Field: Emergency Contact Relationship
Type: Dropdown
Options: Parent, Guardian, Grandparent, Aunt/Uncle, Family Friend
Required: Yes

Field: Emergency Contact Available Hours
Type: Text
Required: No
Help Text: "When is this contact typically available? (e.g., 'Weekdays 9-5')"

Previous Experience Fields

Field: Martial Arts Background
Type: Dropdown
Options: None, Karate, Taekwondo, Jiu-Jitsu, Boxing, Wrestling, Other
Required: No

Field: Years of Experience
Type: Number
Min: 0
Max: 50
Required: No (only if background selected)

Troubleshooting Common Issues

Field Configuration Issues

Issue: Field not appearing on forms
Solution: Check field visibility settings, verify form integration, ensure proper permissions

Issue: Validation not working correctly
Solution: Review validation rules, test with sample data, check error message configuration

Issue: Dropdown options not saving
Solution: Verify option format, check for special characters, ensure proper permissions

Issue: Field data not exporting
Solution: Include custom fields in export templates, verify field mapping, check export permissions

Next Steps

After setting up configurable fields:

1. Configurable Values - Manage system values and options
2. Data Import & Export - Include custom fields in data management
3. System Settings & Configuration - Additional system customization
4. Student Management - Use custom fields in student management

Getting Help

For configurable fields assistance:

• Plan field requirements carefully before implementation
• Test fields thoroughly with sample data
• Train staff on new fields and their purpose
• Monitor field usage and completion rates
• Contact support for complex field configuration issues

Custom fields enhance MartialFlow's flexibility to meet your school's unique needs. Careful planning and implementation ensure these fields provide value while maintaining usability and data quality.