Cargo-Planner Docs

Custom fields

Custom fields allow you to capture additional information specific to your business needs when creating and managing loadlists. Whether you need to track customer order numbers, special handling requirements, or compliance information, custom fields provide the flexibility to extend your cargo planning workflow.

Overview

Custom fields can be configured at the company level and will appear in all loadlist creation and editing forms. Each field can be customized with:

  • Field Name: The label that appears to users
  • Field Type: Text, Number, Checkbox, or Select dropdown
  • Required/Optional: Whether the field must be filled out
  • Default Values: Pre-populate fields with common values
  • Descriptions: Helpful hints that guide users on what information to enter

Setting Up Custom Fields

Accessing Custom Field Configuration

  1. Navigate to Company Settings
  2. Expand the “Loadplan settings” section
  3. Scroll to the “Custom fields” area
  4. Click “Add custom field” to create your first field

Field Types

Text Fields

Perfect for capturing free-form information like customer references, special instructions, or notes.

  • Use cases: Customer order numbers, booking references, special instructions
  • Default value: Pre-fill with common text (e.g., “Standard handling”)
  • Description: Guide users on format or requirements

Number Fields

Ideal for numeric data such as temperatures, weights, or quantities.

  • Use cases: Temperature requirements, priority levels, container counts
  • Default value: Set common numeric values
  • Validation: Automatically ensures only numbers are entered

Checkbox Fields

Great for yes/no questions or boolean flags.

  • Use cases: Hazardous materials, refrigerated cargo, expedited handling
  • Default value: Choose whether the checkbox is checked by default

Select Dropdowns

Provide users with predefined options to ensure consistency.

  • Use cases: Shipping terms (FOB, CIF, etc.), priority levels, cargo categories
  • Options: Define multiple selectable values
  • Default value: Choose which option is pre-selected

Field Configuration Options

Required Fields

  • Mark fields as required to ensure critical information is always captured
  • Required fields show an asterisk (*) and prevent form submission if empty
  • For checkbox fields, required status ensures a conscious choice is made

Default Values

  • Speed up data entry by pre-filling common values
  • Text/Number: Set any default text or numeric value
  • Select: Choose which option is selected by default
  • Checkbox: Set whether the box is checked by default

Descriptions

  • Add helpful hints that appear below each field
  • Guide users on what information to enter or formatting requirements
  • Descriptions are always visible to reduce errors

Using Custom Fields

Creating New Loadlists

When creating a new loadlist, custom fields will appear at the bottom of the form with:

  • Pre-filled default values (if configured)
  • Helpful description text below each field
  • Required field indicators (*)
  • Only required fields are shown during initial creation

Editing Loadlist Details

In the loadlist details page, custom fields appear in the expandable section with:

  • All custom fields (both required and optional)
  • Current values for existing loadlists
  • Description hints for guidance
  • Full editing capabilities

Viewing Custom Field Data

Custom field information appears in the loadlist details section alongside:

  • Customer information
  • Port of loading/destination
  • ETD (Estimated Time of Departure)
  • Other loadlist metadata

Troubleshooting

Fields Not Appearing

  • Ensure custom fields are saved in Company Settings
  • Check that you have appropriate permissions to view/edit fields
  • Verify the field type is configured correctly

Default Values Not Working

  • Confirm default values are set in the field configuration
  • Check that field types match the expected data format
  • For checkboxes, ensure defaults are set as “true” or “false”

Description Hints Not Showing

  • Verify the description text is saved in the field configuration
  • Check that the field has content in the “description” property
  • Ensure you’re viewing the form where hints should appear

Custom fields provide powerful flexibility to adapt Cargo-Planner to your specific business needs. Any issues? Contact [email protected]