AFAQY Knowledge Base
    Custom Fields
    Custom Fields

    Custom Fields

    📖 Afaqy Knowledge Base / AVL / Resources / Custom Fields

    CONTENTS
    ‣
    Introduction
    • About Afaqy
    • AVL Pro
    ‣
    Technical Requirements
    • Recommended Web Browsers
    • Hardware Specifications
    • Internet Connection
    ‣
    Quick Start
    • Account Setup
    • Logging In
    • Resetting Password
    • Glossary
    ‣
    Map
    • Map Navigation
    • Map Tools
    ‣
    Monitoring
    • Monitoring List
    • Monitoring Tools
    • Monitoring Fields
    ‣
    Dashboard
    ‣
    Statistics
    • Overview
    • Accessing Statistics
    • Filters & Controls
    • Units
    • Status
    • Others
    • Activity & Reporting
    • Exporting Data
    • Related Pages
    ‣
    Charts
    • Chart Types
    • Creating a chart
    • Chart Tools
    ‣
    Geofences
    • Overview
    • Purpose
    • Page Components
    • Display Modes
    • Unit Count Indicator
    • Actions
    • Best Practices
    ‣
    Reports
    • Reports Tab
    • Templates Tab
    • Schedules Tab
    ‣
    Report Categories Breakdown
    • Summary Reports
    • Vehicle Activity Reports
    • Driving Quality Reports
    • Zones Activity Reports
    • Sensors Activity Reports
    • Other Reports
    ‣
    Units
    • Selecting Columns
    • Creating a Unit
    • Creating a Sensor
    • Creating a Command
    • FAQs
    ‣
    Units Management
    • Importing Units
    • Accessing Units
    • Unit Groups
    • Unit Shared Groups
    • Exporting Units
    • Deleting Units
    • FAQ
    ‣
    Messages
    • Permissions
    • Tracing Messages
    • Table View
    • Graph View
    • Common Tools
    • Troubleshooting
    ‣
    Second By Second
    • Permissions
    • Scope & Limits
    • Tracing Second by Second
    • Table View
    • Graph View
    • When to use
    • Troubleshooting
    ‣
    Tracking
    • Tracking Fields
    • Generating a track
    • Tracking Tools
    ‣
    Multi-Unit Follow
    • Screen List
    • Maps
    ‣
    Users
    • Selecting Columns
    • Adding a user
    • Users Management
    • Roles & Permissions
    • User Activity & Auditing
    • Best Practices
    • Permissions & Visibility
    ‣
    Geofences
    • Geofences List
    • Markers List
    ‣
    Geofences Management
    • Importing Geofences
    • Accessing Geofences
    • Geofences Groups
    • Exporting Geofences
    ‣
    Customers
    • Selecting Columns
    • Adding a customer
    • Customers Management
    ‣
    Resources
    • Trailers
    • Drivers
    • Events
    • Status
    • Custom Fields
    ‣
    Settings
    • Protocols
    • Packages
    • Roles & Permissions
    ‣
    Audit Log
    • Overview
    • Purpose
    • Scope of Logged Activities
    • Page Components
    • Event Details
    • Export & Retention
    • Access Control
    • Best Practices

    The Custom Fields section enables administrators to create and manage additional data fields that can be attached to core entities such as Units. Custom fields provide flexibility to capture organization-specific data that is not available in default system fields.

    Prerequisites

    • Custom Fields must be installed/enabled for your account before it appears in the system.
    • Access to manage Custom Fields depends on permissions/settings (only authorized roles can create, edit, or delete custom fields).

    Overview

    Custom fields allow users to:

    • Add tailored fields to existing entities
    • Capture extra metadata required for reporting and filtering
    • Ensure consistency in data collection across all units and objects
    • Tailor the AVL system to specific business workflows

    Creating a Custom Field

    1. Go to Resources → Custom Fields.
    2. Click Add Custom Field.
    3. Fill in:
      • Resource type (currently: Units only)
      • Custom field type (Dropdown list, General, Date, Email, Phone)
      • Custom field key
      • Default value (optional)
      • Measurement unit (optional)
    4. Click Save.

    Editing a Custom Field

    1. Locate the field in the list.
    2. Click Edit.
    3. Update the needed values.
    4. Choose whether to apply the changes:
      • Retroactively (update existing records), or
      • From now on (upcoming records only)
    5. Click Save.

    Deleting a Custom Field

    To delete a custom field:

    1. In the custom fields table, click the Delete icon next to the custom field.
    2. Click List Trashed in the table header.
    3. From the trash list:
      • Permanently delete the custom field using Delete
      • Restore a deleted custom field using Restore

    Assigning Custom Fields to Entities

    1. Go to Resources → Custom Fields.
    2. Open the Custom Field tab. (Currently supports Units only.)
    3. When creating or editing a Unit, scroll to the Custom Fields section.
    4. Enter/select the required values.
    5. Click Save.
    💡

    Custom fields appear in the Monitoring screen and Reports (when configured), but they are not included in exports.

    Best Practices

    • Name clearly: Use clear, descriptive labels that reflect real business meaning.
    • Use Dropdowns for consistency: When possible, use dropdown or checkbox types to avoid free-text inconsistencies.
    • Plan before creating: Identify which entities need custom data and plan fields accordingly.
    icon
    Resources