Skip to main content

User requirements

User requirements allow you to set fields to be displayed in your front end when performing certain actions, such as creating a new user or placing an order. You can even make certain fields required. Configuring such user requirements can be easily done in its namesake chapter in Admin Suite.

The chapter's initial landing page gives an overview of all existing user requirement sets (if any). A set in this context means a collection of standalone user requirements and their respective configurations.

User requirement sets apply to organization unit sets; these are displayed in the overview.


As an example, the set of requirements shown in our overview contains the following:

We want to obtain the DateOfBirth, EmailAddress, FirstName, and LastName when new customer profiles are being added - while having only the DateOfBirth as a preferred requirement (i.e. not necessary to be filled in).


Authorization

To access this chapter, you need the UserRequirements permission. Permissions are managed from the Roles and rights chapter namely, from the functionalities card of a users role.

Creating a set

Click the + in the top right corner to create a new set. Creating a new set works the same as editing an existing one.


First, we give our set a name and specify to which OU set it should apply. Then, we can get to configuring our user requirements.

A user requirement consists of the following components:

  1. Name of requirement
  2. User type
  3. Required for
  4. Display type
  5. Requirement visibility

Required for

Required for can be set to one of the following values:

  • None
  • Create
  • Place order
  • Payment
  • All

For example, when setting this to Create, our configured user requirement will only apply to user creation.

This field ties together with the display type. When the display type is set to Preferred, this field can be used only to make that field preferred for certain operations. When the display type is set to Regular, the field will be mandatory instead of preferred.

Display type

When setting the display type to Regular, the requirement will appear as a standard field. When changing this to Preferred, our applications will show a message urging you to fill in this field, but it's not mandatory.

Requirement visibility

Visibility specifies whether or not the requirement is displayed. If set to Hide, this field will be hidden in our applications.

Additional custom fields

Depending on the combination you make in the fields above, additional fields may show up. An important example is the 'Shipping method' field, which shows itself when you pick 'PhoneNumber' as a requirement and 'Place order' as what it's required. This combination can then make a phone number required when placing an order with that specific shipping method.

Custom fields

If these fields still do not fit your preferences, you can use Custom fields to further customize it.