User Fields (User Defined Fields)

A User Defined Field must be created when using the Specify Custom Task.
UDFs can also be created and used on items without being added to a step in the Add Item Workflow.

• If not part of a workflow, the field will appear only on the order.

• If no Add Item Workflow exists, it will appear in the Item Details of the Driver App.

Steps to Create:

1. Go to Accounts → Profiles → open the desired profile.
   

2. In the Profile details, scroll to User Defined Fields and click Edit.
   

3. If fields already exist, they will be listed here.

4. Click Add Field to create a new UDF.

5. Select the Field Association Type:

   • Order Fields – associated with the entire order, displayed in the Order Additional Info tab alongside Reference fields.

   • Order Item Fields – associated with an item/parcel, displayed in the Items tab.

6. Enter a unique ID (letters, numbers, and underscores only).

7. Enter the Display Name (EN) – this appears in the relevant tab.

8. Optionally enter Display Name (FR) – can be left blank.

9. Select the Field Type:

   • Free Text – allows text entry or barcode scanning.

   • Accepted Values – enter one value per line.

   • Dropdown – selectable values from a predefined list.

10. Set View on Self-Serve Order:

    • Visible – shown to account users.

    • Hidden – not shown to account users.

11. Enable Updatable by Driver if required.

    • Note: For drivers to update an Item User Field, their profile must have Add, edit, delete parcel enabled.

12. Click Save.

13. 
    

Editing User Defined Fields

You can modify most details of a UDF after creation, except for the Item Type and ID.

Steps to Edit:

1. Go to Accounts → Profiles → open the desired profile.

2. In the Profile details, scroll to User Defined Fields and click Edit.

3. Click on the ID of the field you wish to edit.

4. Update the desired information.

5. Click Save.

Archiving User Defined Fields

UDFs cannot be deleted, but they can be archived if they are not used in a Workflow Task.

Steps to Archive:

1. Go to Accounts → Profiles → open the desired profile.

2. In the Profile details, scroll to User Defined Fields and click Edit.

3. Click the Archive icon next to the field.

4. Click Archive to confirm, or Back to cancel.
   

Note:

• If the field is used in a Workflow Task, an error message will appear:

This field is used in a Workflow Task and cannot be archived.

Best Practice Tip: Before archiving a UDF, ensure it is not linked to any active workflow to avoid errors.