Page tree
Skip to end of metadata
Go to start of metadata

In CartonCloud, you can create custom fields against many different models, useful for storing your own business-specific information to handle your workflow.

Currently Carton Cloud will allow up to 10 customer fields to be added on your Consignment Template

We're adding Custom Fields to additional models on an almost weekly basis, we're moving toward having custom fields available on all objects.


Adding Custom Fields

To get to the Custom Fields page, simply type: "Custom Fields" into the "Search for Anything" box at the top of the system:

From here, you can jump between the various models which support Custom Fields.


To add a Custom Field simply click the "Add Custom Field" button.

Image to Add custom fields for Container entity

Fields of Custom Field

FieldDescriptionRequired to create Custom FieldDefault
NameName of the Custom Field. Will be visible on tables, export files and forms for the entity of Custom Field (Container Model in our example above)Yesempty
Short NameShort Name of Custom Field. Can be used in different tables and export files.Noempty
Custom Field Type

Defines the type of Custom Field. Refer to Types Of Custom Fields.


Text
Required (checkbox)Custom Field will be required when adding or editing this custom field.YesChecked
Show in Headings (checkbox)Custom Field Visible on Tables for the entityYesChecked
Enable (checkbox)Custom Field is enabled for the entity. If disabled, this field will not appear for the entityYesChecked
Is Primary Field (checkbox)

Specifies if this field is to be used as primary field for referencing the entity. This field is treated as primary field ONLY if entity does not have default primary field for referencing. For example, Containers and Shipments don't have default primary fields.

Note

One of the custom fields must be a primary field. If the user does not specify it, the system assigns the last created custom field to be the primary field.
YesUn-Checked
Map Field Name

Field name to be used to map columns from imported files to the entity.

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 container, if it contains a column "reference", it will map to "Reference" custom field for Container.

Yesempty


Types of Custom Fields

TypeDescription
Integer

Custom field will accept numbers only without decimals.

DecimalCustom field will accept both numbers and decimals.
TextCustom field will accept both text and integer
DateTimeCustom field will accept Date only. On clicking DateTime Custom Fields a calendar will automatically popup to select the date.
Boolean

Custom Field will act as dropdown with only two options, "Yes" and "No". Is useful for doing checkbox type actions.

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

DropDown

Custom Field will act as dropdown for entity with predefined options.

When selected in "Add/Edit Custom Field" page, a field will show up called "Drop Down Options" where the user can list down the options for this dropdown box in a comma separated format.

Example: We want to show three values in our drop down "value1", "value2" and "value3". We will write it as "value1, value2, value3".



Actions on Custom Fields

Once a custom field is added, following actions can be done on it: 

1) Edit

Edit a custom field. A form just like Add Custom Field is displayed with values of that Custom Field. Everything about the custom field can be edited.

2) Delete

Custom field can be deleted.

Note

Since deleting the custom field would mean deleting all the records for that custom field from its related entity, therefore be very careful when carrying out this action. Make sure it will not affect anything in the application, since this data can not be retrieved once deleted.


3) Move Position

The sequence of custom fields on different forms, tables and export files will be the same as that in Custom Field settings. The one appearing first will be shown first and the one appearing last will be last. In order to change the sequence of custom fields, us the "Move Up" and "Move Down" buttons (shown in the diagram above).

  • No labels