Custom user & group types

In some scenarios – typically scenarios where users are imported from an external system, or solutions where role-based access control is important – the regular users and users groups are not sophisticated enough.

In those scenarios, you can create custom user types and custom user group types using a system reminiscent of item types – which is to say:

  • You can control which fields are available on the user or user group type
  • You can control where each type can be used – which types can be used in the root, what types can be created as children, etc.

For example, if you import ‘companies’ from your CRM, you can create custom user type for them – and then an ‘employee’ type which can only be used under a company.

As such, custom user and group types allow you to take full control over how user-related data is stored and organized.

The general idea with custom types is that you first create the type, then later create users or user groups based on those types.

To create a custom user type:

  • Go to Settings > Control Panel > Users > User and group types
  • Click New user/group type in the toolbar (Figure 2.1)
Figure 2.1 Create a new custom type

A couple of basic settings must be configured before selecting fields for the type:

  • Enter a name
  • (Optional) Provide a description
  • Select a template typeUser or Group
  • (Optional) Select an icon

You can also configure where in the users tree this type can be created via the allowed parents section (Figure 2.2).

Figure 2.2 You can edit the restrictions for the custom type

In this case, the type is only allowed in the Root of the Users-tree, and under default groups.

Once the basic properties like the name has been defined, you can select a set of fields which should be available on the particular user or group type.

Depending on the template type selected – user or group – some fields are system critical and must be included. They are:

  • For group types the Name field must be included and editable
  • For user types at least one of the following fields must be included and editable:
    • Username
    • Name
    • Email

Not all fields make sense or appear on both template types – the following fields are for group types:

Fields available on group types

Notes

Address

 

Address 2

 

Allow backend

Ribbon bar

City

 

Company

 

Country

 

Customer number

 

Default permission

 

Fax

 

Frontend start page

 

GeoLocationImage

 

GeolocationIsCustom

 

GeoLocationLat

 

GeoLocationLng

 

Job title

 

Mobile phone

 

Name

 

Phone

 

Phone (private)

 

State or region

 

Users

 

Zip code

 

The following fields are available for user types:

Fields available on user types

Note

A value added tax identification number

 

Active

Ribbon bar

Address

 

Address 2

 

Allow backend

Ribbon bar

Billing / Shipping country

 

Can send e-mail

 

City

 

Company name

 

Country

 

Created by

 

Created on

 

Currency

 

Customer number

 

Department

 

Disable live prices

 

Email permission updated on

 

External id

 

Fax

 

First Name

 

Frontend start page

 

GeoLocationImage

 

GeolocationIsCustom

 

GeoLocationLat

 

GeoLocationLng

 

Groups

 

House number

 

Image

 

Item type

 

Job title

 

Last login time

 

Last Name

 

Last order date

 

Mobile

 

Name

 

Phone

 

Phone (business)

 

Phone (private)

 

State or region

 

Updated by

 

Updated on

 

User e-mail

 

User name

 

User password

 

User type

Ribbon bar

Valid from

Ribbon bar

Valid to

Ribbon bar

Zip code

 

As soon as the custom user or group type has been created, it will be available in the backend when creating new users or groups (Figure 4.1) – provided, of course, that the restrictions section of the type definition allows it.

Figure 4.1 You can now select your custom types when creating new users/user groups