Advanced Custom Fields

Advanced Custom Fields allow you to extend your system's functionality by adding custom data collection points throughout various sections. These fields provide flexible data input options that can be tailored to your specific requirements.

Overview

cogs

Flexible Field Types

Support for multiple field types including text inputs and dropdown selects to match your data collection needs.

sitemap

System-wide Integration

Deploy custom fields across multiple sections of your system for consistent data collection.

Field Types

Text fields provide open-ended input options for users to enter custom information.

Key Features:

Configurable placeholder text
Required/optional field settings
Visibility controls
Character validation

Best for: Names, descriptions, IDs, comments, and other free-form text data.

Configuration Options

sliders-hField Properties

Required Properties

ID: Unique identifier for the field
Name: Display name shown to users
Type: Field type (text or select)
Required: Whether the field must be completed
Visible: Controls field visibility in the interface

Optional Properties

Placeholder: Helper text displayed in empty fields
Options: For select fields, define available choices with names and values

eyeField Visibility

Control when and where your custom fields appear:

Visible: Field is displayed and available for input
Hidden: Field exists but is not shown to users
Conditional: Display based on other field values or user permissions

Implementation Examples

Text Field Example

{
  "id": "customer_notes",
  "name": "Customer Notes",
  "type": "text",
  "placeholder": "Add any relevant notes...",
  "required": false,
  "visible": true
}

Select Field Example

{
  "id": "priority_level",
  "name": "Priority Level",
  "type": "select",
  "required": true,
  "visible": true,
  "option": {
    "name": "High Priority",
    "value": "high"
  }
}

Best Practices

tag

Field Naming

Use clear, descriptive names that users will easily understand. Avoid technical jargon or abbreviated terms.

asterisk

Required Fields

Only mark fields as required when the data is absolutely necessary. Too many required fields can hurt user experience.

list

Option Management

For select fields, keep option lists manageable in size and logically ordered. Consider alphabetical or priority-based ordering.

API Integration

Advanced Custom Fields integrate seamlessly with your system's API endpoints. Use the PUT method to create or update custom field configurations, ensuring your data collection evolves with your needs.

Note: Changes to custom fields may require system restart or cache clearing to take effect across all sections.