What are Custom Fields

Custom Fields allow you to record specific information against different records within CartonCloud. For example, you might want to record the Container Number on a Purchase Order or the Carrier Consignment Note on a Sale Order. 

Note, if you are looking for information on how to use Custom Fields through the API, please see: Custom Fields in the API

How to add a Custom Field 

  • Navigate to the Custom Field page by typing Custom Fields into the Search for anything bar. 
  • From here, you can select what record you would like to add a Custom Field to by selecting the relevant tab. 

  • Once you have selected the correct tab, click +Add Custom Field.  

  • Using the below Field Descriptions, fill in the relevant information for the Custom Field. 

Field Descriptions

FieldDescriptionRequired to create Custom FieldDefault
NameName of the Custom Field. It will be visible on tables, export files and forms for the entity of Custom Field.Yesempty
Short NameShort Name of Custom Field. It can be used in different tables and export files.Noempty
Map Field Name

The Map Field Name maps columns from imported files to the entity. This field is not editable. 

Example: For a custom field named "Reference" for entity "Container", its map field name can be "reference", so that whenever a file is imported for the Container, if it contains a column "reference", it will map to "Reference" custom field for Container. 

Yes
Field Type

Defines the type of Custom Field (refer to the table below, Types of Custom Fields)

YesText
Field Mapping (toggle)

Once enabled, Field Mapping allows you to create a link between two custom fields so that when data is entered in one custom field, it is pulled through to another. For example, if you had a Custom Field for Opening and Closing Times against the address and Consignment, you could link the fields so that the opening and closing times for an address will show against the Consignment. 

NoUn-checked
Options

Required (toggle)With this enabled, the Custom Field will be required against the record. This means the field must be filled when adding or editing the record. YesChecked
Internal Use Only (toggle)

With this enabled, the Custom Field will not be visible to external users (Customer and onforwarder users); only admin, packer and driver users will be able to see the custom field (this includes reports generated by the customer).

This setting is helpful if you want to store sensitive information such as carrier expenses or other internal data from your customers. 

Note that you can NOT have the 'required' setting enabled with this setting enabled. 

This setting is only available against the following Custom Fields; 

  • Consignment Data
  • Consignment Item
  • Transport Product
  • Address
  • Sale Order
NoUn-checked
Display 

Show on MobileCustom Field will appear in the CartonCloud Mobile app (both iOS and Android)YesChecked
Show in Headings

With this selected, you will have the option to add this custom field as an available field in the list view for that custom field. For example, if you add a Sale Order Custom field and select 'Show in Headings', you can configure the Sale Order list view to include the custom field as a heading.

See here (under the heading Configuring the Consignments List View) for more information on how to edit the list view.



Show on Sort ArrivalsThis Custom Field will appear on the manifest "Sort Arrivals" screen when enabled.NoUnchecked
Active / Enabled (toggle in top right corner) With the toggle enabled, the Custom Field will be active and visible for the entity. If disabled, this field will not appear for the entity.YesActive (checked)

Field Types

TypeDescription
Integer

The custom field will accept whole numbers only without decimals.

DecimalThe custom field will accept both numbers and decimals.
TextThe custom field will accept both text and numbers.
DateThe custom field will accept dates only. On clicking DateTime Custom Fields, a calendar will automatically popup to select the date.
Boolean

Custom Field will act as a dropdown with only two options, "Yes" and "No". It helps do checkbox type actions.

When selected in the "Add/Edit Custom Field" page, a field called "Default Custom Field Option" will define the default option for this type of custom field.

Drop Down

Only available on the following custom field types,

  • Address
  • Consignment Data
  • Consignment Item
  • Sale Order
  • Transport Product

The custom field will act as a dropdown with predefined options. With this option selected, a field called Drop Down Option will appear, allowing the user to define options from the dropdown box. 

These fields can then be reordered by dragging and dropping the dropdown option and repositioning it as required. The order of the fields will be reflected in the other areas of the system which use those custom fields, for example, when adding a new consignment. 

Dropdown Default Value

If none is specified, you can define which value you want the dropdown to use in the Default field. 

This is particularly useful for the Consignment Data "Service" custom field, as it allows you to define what service a consignment should use by default, including when a consignment is generated from a Sale order.

Video Guide 

Editing, Enabling and Disabling Custom Fields

Once a custom field is added, it cannot be deleted; however, it can be disabled. This removes the chance of deleting historical data contained within that custom field.

  • To edit a custom field, select the  icon next to it (in the Action column).
  • To disable an active custom field, select the toggle, which will become inactive.
  • To enable an inactive custom field, select the toggle, and it will become active.

Customer Visibility

Custom Fields are visible to customers if the Internal Use Only setting is not enabled. However, if this setting is enabled, the Customer and onforwarder users will not be able to see the Custom Field; only internal users (admin, packer and driver) will be able to (this includes reports and exports). 

This setting is only available against the following Custom Fields; 

  • Consignment Data
  • Consignment Item
  • Transport Product
  • Address
  • Sale Order

This setting is helpful if you want to store sensitive information such as carrier expenses or other internal data from your customers.

If the custom field is internal only, you will see by the eye icon that the field is internal only when editing a record.


How to change the order Custom Fields appear against the record

Use the up and down arrows next to the custom field to change the order in which they appear against the record. 

Custom Fields on Mobile

To see the Custom Fields on the mobile, you must check the Show on Mobile option when creating the Custom Field.

Use cases for including the Custom Field on the Mobile

This is particularly useful for information such as a delivery site's opening and closing times. When using Custom Field linking, you can automatically pull the opening and closing times stored against the address record to Consignment data which will show on the Driver's mobile device. 

Field Location

This field determines where the custom field will appear on the mobile detail view.

List Or Detail View

When selecting Show on Mobile, you can choose if the custom field will appear on the Detail view within the Mobile or the List and Detail view. Examples of each are provided below.

Example Custom Fields on Mobile

Custom FieldDetail ViewList view
Opening TimeYesNo
Closing TimeYesYes

More Information

See the dedicated Custom Fields on Mobile article for further details on where custom fields will display within the mobile app.

Product Custom Fields

Custom Fields can be created for Product records. You can have up to 10 different Product Custom Fields. These are different to Purchase Order Product Custom Fields as they record information against the inbound stock, whilst a Product Custom Field will record information directly against the Product. Therefore, it can not be altered by individual stock records. For more information on Purchase Order Product Custom Fields, please click here

Custom fields are specified on a Per-Customer basis, allowing each Customer to have their own set of Custom Fields.

Use cases for Product Custom Fields 

This is useful for storing additional information such as:

  • Supplier Codes
  • Dangerous Goods Information / DG Class
  • Special Handling Instructions
  • Other identifiers or data that needed to be stored.
Custom Fields can be displayed on Picklists, Con Notes, etc., via Document Templates; they can also be shown on Stock Reports and Exports.

Enabling Product Custom Fields

  • First, navigate to the Edit Customer Page, Contacts>Customers
  • Click on the relevant Customer. 
  • Click Edit in the bottom left corner. 
  • Select the Warehouse Management tab and then the Product tab. 

  • Add the relevant Custom Fields into the Custom Field boxes.
  • Scroll down and click Save. The Custom Fields will now appear when Adding or Editing a Product
Custom Fields are not required on products; they're optional.