> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alvys.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Set Up Custom References in Alvys

> Define custom-named reference fields on loads, trips, stops, drivers, and other records so your team can capture and search the identifiers your customers use.

<Note>
  📋 **Applies to:** Admin · Partner Admin · Operation Manager

  **Module:** Settings > Custom References

  Custom References let you define and attach custom-named fields to loads, trips, stops, drivers, trucks, and trailers in Alvys so your team can capture business-specific information not covered by standard fields.
</Note>

## Overview

Custom References let you define and attach custom-named fields (also called user-defined fields or custom data fields) to loads, trips, stops, drivers, trucks, and trailers in Alvys, so your team can capture business-specific information not covered by standard fields.

Custom References allow your organization to create additional data fields tailored to your operations. Once defined, these fields appear on the relevant entity pages throughout Alvys and can be included on documents such as rate confirmations and invoices.

Supported field types are Text, Date, Select, and Checkbox. References can be applied to Loads, Trips, Stops, Drivers, Trucks, and Trailers.

Load and Trip Custom References also display on the Driver Mobile App within Trip Details. Driver Custom References display on the Driver Mobile App within the Driver Profile.

Custom Load References appear as custom columns on the Load Board once created.

## Before You Start

You must be an **"Admin"**, **"Partner Admin"**, or **"Operation Manager"** to access Settings > Custom References. This setting must be enabled for your account; if you do not see Custom References in Settings, contact Alvys Support.

## Steps

### Navigate to Settings > Custom References

1. Click your user profile menu in the bottom-left corner of Alvys.
2. Select **Settings** from the menu.
3. Click **Custom References** in the left navigation panel.

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/1aaf0b074439.png" alt="Screenshot showing the Settings navigation with Custom References selected in the left panel." />

  *Screenshot showing the Settings navigation with Custom References selected in the left panel.*
</Note>

### Select the entity tab

1. The Custom References page is organized by entity type. Select the appropriate tab: **Loads**, **Trips**, **Stops**, **Drivers**, **Trucks**, or **Trailers**.
2. The table displays the **Field Name**, **Description**, **Date Created**, and **Created By** for each existing reference on that entity.
3. You can rearrange, sort, and search these columns to manage the list.

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/ab429631c8b0.png" alt="Screenshot showing the Custom References management page with entity tabs (Loads, Trips, Stops, Drivers, Trucks, Trailers) visible." />

  *Screenshot showing the Custom References management page with entity tabs (Loads, Trips, Stops, Drivers, Trucks, Trailers) visible.*
</Note>

### Create a new reference

1. Click the **New Reference** button (blue button in the top right) to open the creation modal.

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/bfd09d26a639.png" alt="Screenshot showing the full New Reference form with all fields visible" />

  *Screenshot showing the full New Reference form with all fields visible*
</Note>

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/996ed03a2ccf.png" alt="Screenshot showing the Driver Mobile App with Load and Trip Custom References displayed under Trip Details and the View All References toggle." />

  *Screenshot showing the Driver Mobile App with Load and Trip Custom References displayed under Trip Details and the View All References toggle.*
</Note>

1. Fill in the following fields:
   * **Name:** Enter a name that is easily identifiable by others in your organization.
   * **Description:** Optionally describe what this reference is intended for.
   * **Field Type:** Choose the type that best suits the data you want to store. Options are Text, Date, Select, and Checkbox. You cannot change the field type after saving.
   * **Include in Alvys:** Check the boxes to indicate which pages in Alvys should display this reference.
   * **Show on documents:** Check the boxes to indicate which documents should display this reference (for example, rate confirmations or invoices).

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/bf5a8fa7e730.png" alt="Screenshot showing the Driver Mobile App with Driver Custom References displayed within the Driver Profile." />

  *Screenshot showing the Driver Mobile App with Driver Custom References displayed within the Driver Profile.*
</Note>

Load and Trip Custom References display on the Driver Mobile App within Trip Details. If you click **View All References**, you can toggle between tabs to see Load or Trip Custom References. Driver Custom References display on the Driver Mobile App within the Driver Profile.

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/bb5d2382e3c0.png" alt="Screenshot from the driver's profile" />

  *Screenshot from the driver's profile*
</Note>

### Save the reference

1. Click **Save**. The reference is immediately available for use on the selected entity.
2. Confirm the new reference appears in the list on the correct entity tab.

The custom reference is now active and visible to all users on the pages and documents you selected. Users can fill in the field when creating or editing the relevant entity (load, trip, stop, driver, truck, or trailer). Custom Load References appear as additional columns on the Load Board.

<Warning>
  ⚠️ You can only create up to 20 references associated with Loads or Trips but unlimited references for Stops.
</Warning>

<Note>
  ℹ️ The custom load references you set up at the Load Level will be mirrored as custom reference columns on the Load Board.
</Note>

## Managing Existing Custom References

To edit an existing reference, click **Edit** on the right side of the row. The creation modal opens with the existing data. You can change the Name, Description, and View settings. You cannot change the Field Type.

Changes to an existing reference apply only to new entities created after you save. Existing and historical records retain the previous reference settings.

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/24325f6d370e.png" alt="Screenshot showing the Edit reference modal for an existing custom reference." />

  *Screenshot showing the Edit reference modal for an existing custom reference.*
</Note>

<Note>
  <img src="https://mintlify.s3.us-west-1.amazonaws.com/alvys/images/help/a5fe97e3fc99.png" alt="Screenshot showing the Enable/Disable toggle inside the Edit reference modal." />

  *Screenshot showing the Enable/Disable toggle inside the Edit reference modal.*
</Note>

<Tip>
  💡 Note: Only stop references that have been attached manually can be edited. Stop references coming from EDI / Ratecon / Marketplace cannot be edited
</Tip>

## Troubleshooting

### Custom References option is not visible in Settings

1. Confirm you are signed in as an **"Admin"**, **"Partner Admin"**, or **"Operation Manager"**. Other roles do not have access to Settings > Custom References.
2. Confirm that the Custom References feature is enabled for your account. If you do not see the option after verifying your role, contact Alvys Support with your account name so they can confirm whether the feature is enabled.

### Reference appears grayed out in the list

1. A grayed-out reference has been disabled. Click **Edit** on that row.
2. Toggle the **Enable** switch in the top-right corner of the modal to the Enabled position and click **Save**.

### New reference does not appear on loads or other entities

1. Confirm you checked the correct boxes under **Include in Alvys** when creating the reference. If the relevant page was not checked, the field will not appear there.
2. Open the Edit modal for the reference, verify the Include in Alvys selections, update as needed, and save. The change applies to new entities only; existing records are not affected.

## FAQs

**Q: Where do I enter a custom reference for a driver once it has been created in Settings?**

**A:** You can add Driver custom references on the Driver Profile page.

**Q: What happens to existing loads if I change the View settings for a Custom Load Reference?**

**A:** The change applies only to new loads created after you save. Any existing or active loads retain the previous view settings. Review any references previously set to show on all documents, as their display settings on historical loads will not change.

**Q: Why is my custom reference grayed out in the list?**

**A:** A grayed-out reference has been disabled. To re-enable it, click the Edit icon, toggle the Enable switch in the top-right corner of the modal to the Enabled position, and save.

**Q: How many custom references can I create?**

**A:** You can create up to 20 custom references for Loads and up to 20 for Trips. There is no limit on references for Stops, Drivers, Trucks, or Trailers.

**Q: Can I sort and filter by custom references on the Load Board or Dispatch Planner?**

**A:** Sorting and filtering by custom reference columns on the Load Board and Dispatch Planner is not yet available. This capability is planned for a future release.
