Introduction to Custom Fields (optional)
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
| Field | Description | Required to create Custom Field | Default |
|---|---|---|---|
| Name | Name of the Custom Field. It will be visible on tables, export files and forms for the entity of Custom Field. | Yes | empty |
| Short Name | Short Name of Custom Field. It can be used in different tables and export files. | No | empty |
| 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) | Yes | Text |
| 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. | No | Un-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. | Yes | Checked |
| 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 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. | No | Un-checked |
| Display | |||
| Show on Mobile | Custom Field will appear in the CartonCloud Mobile app (both iOS and Android) | Yes | Checked |
| 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 Arrivals | This Custom Field will appear on the manifest "Sort Arrivals" screen when enabled. | No | Unchecked |
| 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. | Yes | Active (checked) |
Field Types
| Type | Description |
|---|---|
| Integer | The custom field will accept whole numbers only without decimals. |
| Decimal | The custom field will accept both numbers and decimals. |
| Text | The custom field will accept both text and numbers. |
| Date | The 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,
| 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 ValueIf 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
If you're not sure what Custom Fields you want to set up after reading this article don't worry, you can come back and add them in later. However, the reason Custom Fields are covered at this stage of the setup is so that all CartonCloud records moving forward will capture the Custom Fields data that you set up.