Skip to main content

How to use Custom Fields

The way to add your own fields to product, inventory, item-template, and profile objects.

Updated over 2 months ago

Overview

Custom Fields allow users to create additional fields to products, inventory items, item-templates, and profiles. These fields are present object-wide, meaning if I added a new custom field to product, it will be present for all products. Within this article, we'll go through the details of Custom Fields.


Creating a Custom Field

To create a new custom field:

  1. Go to the settings tab on the left side bar.

  2. Navigate to the Custom Fields section on top of the page.

  3. Click on the button "Add Custom Field".

  4. Choose which object you want to create a new custom field for.

    1. Inventory Item

    2. Product

    3. Item Template

    4. Profile

  5. Name the field.

  6. Select the data type of the field.

  7. Apply any validations you desire.

    1. This helps to ensure that the field will be filled out correctly.

  8. Toggle any options present at the end of the form.

Tips for Custom Fields

  • Use short, clear field names that users will understand

  • Choose the appropriate data type for the information you need

  • For Text fields with fixed options, use the "Define preset options" feature

  • Only mark a field as "required" if the information is essential

  • If you need to temporarily hide a field, disable it rather than deleting it

  • Enable "Allow multiple selections" when users should be able to choose more than one option

Using Custom Fields

Once you have created your custom field for a resource, you will see that custom field present in all instances of that resource.
​
For resources that have existing instances like an existing inventory item, that custom field will not be set to anything.If you mark the custom field as required, you will be required to fill out that field the next time you make an edit to that existing instance.

Did this answer your question?