Order Fields

Order Fields are used to assign custom values to orders. These values can then be utilised by Aurora for certain features and optionally displayed when creating a new order.

This article provides an introduction to the principle of order fields and guides you through creating them.

📘

To administer Order Fields, please ensure the user has been given the applicable Access Rights under Orders > Order Fields

Search Order Fields

Order fields can be managed in Aurora by navigating to Orders > Order Fields. A paginated list of all the order fields will be displayed.

The listing page provides the ability to filter Order Fields. Using the search box displayed at the top of the listing page you can enter a search term to match on the fields “name” value. A filtered list of results matching your search criteria will then be displayed.

The screenshot below shows all Order Fields with names containing the value De.

The order fields listing page can also be customised to aid searches, by clicking on the cog icon, the number of results and alphabetical sorting options are displayed.

Creating Order Fields

A new order field can be created by clicking on the green Add New Field button on the top right of the listing page. The Add Order Field page will be displayed with an empty form.

The following table lists the description for each field.

FieldDescription
NameThe unique name of the order field. This value is used when displaying and listing.
Is EditableWhen checked the value entered for this field can be modified when viewing an existing order.
Allow Manual EntryWhen checked the order field will be displayed when creating new manual order.

🚧

New Order Field Restrictions

There are a number of restrictions that will prevent a new order fields from being created

The Order Field “name” must be unique. If you attempt to create a new order field with a name that is already in use an error will be displayed.

The Order Field “name” must not contain invalid characters. The supported characters include white space, alphanumeric, '+', '_' and '-'.

The total number of Order Fields that can be created in total is 100. If you attempt to create more that 100 fields an error will be returned. Please contact Aurora support if you have requirements which exceed this limit.

Editing Order Fields

You can modify existing Order Fields from the listing page by either clicking on the name of the desired field or the pencil icon. This will display the Edit Order Field page.

The page will display a populated form. Once the required changes have been made, clicking Edit Field will save the changes.

🚧

Edit Order Fields Restrictions

Take care when editing a Field Name to ensure it’s new name continues to contain the original context. If the name is changed to something unrelated you might lose understanding of what values have already been captured on existing orders. For example, renaming an Order Field Name from “Parcel Height” to Parcel Weight.

In these cases it would be more appropriate to create a new order field.

Creating Orders with Order Fields

For any fields which have the Allow Manual Entry checkbox selected, these will appear as additional text boxes options when creating manual orders.

Navigate to Orders > New Order

The heading section Order Fields will display the configured fields with a text box allow for optional data. Any values entered here will be assigned to the new order, once the order is placed.

Edit Orders with Order Fields

Once you have created order which contain custom order fields data you can view these by navigating to the Orders > New Order page and selecting the relevant order.

When editing an order, navigate to the Additional Fields tab.

A list of the Order Fields will be displayed

If the Order Field has been configured to allow editing, the order field will have a pencil icon displayed to the right of the value.

Clicking this icon will allow manual modification of the value entered when the order was created. Any fields that have not been configured to allow editing will not have this option available.