Custom Fields

Custom fields allow you to store additional data in different areas of your company:

• User … per user (e.g. discount, language)

• Company/Distributor … per company or distributor (e.g. region)

• Quote … per quote (e.g. terms of payment)

• Quote Item … per line item (e.g. delivery time)

Pro Feature

The availability of custom fields depends on your subscription!

Contact us if you are interested in enabling (more) custom fields in your Company.

Creating custom fields

Each custom field consists of three properties:

• Name must be a valid Hive identifier. Names are case-insensitive, so discount and Discount are considered as the same

• Type is one of the Hive types Number, Text, Logic, List<Number> or List<Text>

• Fallback Value is the value of the field that will be used if no explicit value for this field is set.

You can create and manage custom fields on your company’s Settings page.

• Define fields and fallback values.

• Assign values at the Company or Distributor level.

• For User Custom Fields, you can also assign values per individual user.

Published Configurators are not affected

When you create, modify or delete a custom field, your staged or published configurators won’t be affected immediately – they must be published again to use the updated fields.

This is a safeguard to protect these configurators and allows you to adapt them as necessary when you have to alter fields.

Note that changes to field values do affect staged and published configurators!

Distributor

On the Distributor Settings page, you can only set distributor-specific values. If no value is set, the Fallback Value is used.

Types of custom fields

You can create different types of fields to support various use cases in configurators.

User Fields

Custom field values for the signed-in user are accessible in Hive, in the user.fields variable.

Examples

• Apply different discounts to sales users.

• Restrict feature availability based on user fields.

• Add a UserId field to fetch external user data from workflows.

Value Priority

1. User-specific value (set on the Users page)

2. Company/Distributor value

3. Fallback value

Hive Example

// assuming you created a custom field 'Discount' 
BasePrice * (1 - user.fields.Discount)

Note that you do not have to check a field value for Empty, because even if no value for this field is set on the current user (or the user isn’t signed in), the field will still have a value thanks to the Fallback Value.

See the Hive User docs for more details on the user variable.

Company/Distributor Fields

Company and distributor custom fields are available via configurator.owner.fieldsin Hive.

Examples

• Define regions per company or distributor.

• Limit configurator features by company.

• Restrict products for certain distributors

Value Priority

1. Company/Distributor value

2. Fallback value

Hive Example

// assuming you created a custom field 'Region' 
configurator.owner.fields.Region

Note

You do not have to check a field value for Empty, because even if no value for this field is set, the field will still have a value thanks to the Fallback Value.

See the Configurator Variable docs for more details on the configurator variable.

Quote Fields

Quote custom fields let you enrich your quote infrastructure.

Examples

• Add terms of payment to your quotes

• Mark important quotes with a custom severity level

Value Priority

1. Company/Distributor value

2. Fallback value

The fallback value of a Quote custom field is used, if no value is provided for the currently selected company or distributor. If you define a Company/Distributor value, then this value will be used when no value is provided during Checkout.

Hive Example

Coming soon after this feature is available!

Quote Item Fields

Quote item custom fields apply to each line item of a quote.

Examples

• Add an image field to each line item.

• Define delivery times per product.

Value Priority

1. Company/Distributor value

2. Fallback value

The fallback value of a Quote Item field is used, if no value is provided for the currently selected company or distributor. If you define a Company/Distributor value, then this value will be used when no value is provided during Checkout.

Hive Example

Coming soon after this feature is available!