User Custom Fields
  • 16 Jul 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

User Custom Fields

  • Dark
    Light

Article summary

This feature allows you to store additional data in each user of your company. The custom field values of the currently signed-in user are accessible in Hive, thus allowing you to augment the configurator for that particular user.

Some examples for how to use this feature:

  • set different Discounts on your sales users

  • limit the availability of certain features in your configurator based on a custom field

  • add a custom UserId field and use it to load additional user data defined in a data source that you can update automatically via workflows

You find custom fields in the Users page, where you can also assign field values for all users in your company.

Pro Feature

The availability of this feature depends on your subscription!

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

Creating custom fields

A custom field consists of 4 properties:

  • Name must be a valid Hive identifier. No two fields may have the same name – keep in mind that Hive identifiers are case insensitive (so discount and Discount are considered the same)

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

  • Default Value is the value of the field that will be used if no explicit value for this field is set on a particular user. A newly added user will have all fields set to their default.

  • Anonymous Value is the value of the field that will be used when the configurator is opened by a user that isn’t signed in

You can modify and delete custom fields at any time. Keep in mind that when deleting a custom field, the values for that field in all users will also be deleted.

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!

Using custom fields in Hive

All custom fields are available in the user variable, specifically in its fields property:

// 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 Default Value and Anonymous Value.

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


Was this article helpful?