Skip to main content

User fields

Navigate: Menu > System > User fields

info

In progress, coming soon!

The user fields are the data fields that users can have in the LMS along with any allowed values, limitations, and other options.

In this section​

List user fields​

The user fields are presented in a standard table.

Columns​

  • Name - the name of the field, in snake_case
  • Label - the label of the field is the name that will be visible in the interfaces
  • Predefined
    • Yes - user fields are predefined and are not editable from the admin panel
    • No - user fields settings can be edited and managed by super admins in the admin panel
  • Description - the short description of the user field
  • Updated - the time the user field was last updated at

Filters and actions​

Add a new user field​

To add a new user field, click on the "Add" button in the right upper corner of the user fields table, and provide the following information:

  • Name in snake_case: provide the name of the field in snake_case e.g. if the name is business unit, in snake case it's business_unit, with no spaces in between words.
  • Label for user interfaces: provide the name of the field, this is the name that will be visible from the user interfaces.
  • Short description: provide a description of the field, this description is visible in the user fields table under the "Description" field.
  • Description: provide an additional description, this field is optional
  • Permission labels: choose here the most relevant
    The fallback content to display on prerendering
    for this
    The fallback content to display on prerendering
    .
note

At the bottom, you can see the existing undefined user fields. These are user fields that exist in the user data in the system, but are not yet defined here. To define/adjust their settings, you'll need to create a new user field with the same field name.

Click on "Create" to create the user field, and you will reach the new user field page.

General information​

Under this tab, you can view and define the following sections:

General​

Edit or review the general information of the user field.

  • Priority: you can define here the priority of the field. The priority is a numeric value, when a priority is not set, if defaults to 0. Using the priority you can organize the order that the user fields are displayed in the assignment and user profile overview/details
  • Column priority (if displayed in users table):
  • Permission labels:

Value options​

  • Data type:
    • string
    • email
    • integer
    • boolean (true/false, preferred boolean option)
    • boolean (1/0)
    • boolean (Yes/No)
    • ISO8601 data (yyyy-mm-dd)
  • Predefined values:
    • Do not predefine any options
    • Predefine values, but also allow additional values - when this option is selected, a Values tab is added to insert the predefined values.
    • Predefine all values, do not allow any other values - when this option is selected, a Values tab is added to insert the predefined values.

Editing options​

  • Editable via user profile - allow editing this field from the user profile in the admin panel
  • Editable via import (Excel) - allow editing this field when importing user data using Excel file
  • Editable via import (integration) - allow editing this field when importing user data via integration
note

To edit the user field from the user profile, you need to make sure that this field is displayed in the user profile overview/details in the Display options below.

Constraints​

  • Permit undefined values - any value of the selected data type will be permitted?
  • Required when editing via user profile - this field will be mandatory to fill when editing via the user profile in the admin panel
  • Required when editing via import (Excel) - this field will be mandatory to have in the user import Excel file
  • Required when editing via import (integration) - this field will be mandatory to have in the user import integration

Display options​

  • Display in reports
  • Display in user profile overview
  • Display in user profile details
  • Display in Learn Portal
  • Display as a column in users lists

Usage options​

  • Allow using in assignments
  • Allow using in advanced search

Miscellaneous options​

  • Private (not accessible regardless of other options)

Values​

info

coming soon!

Edit user fields​

note

Predefined user fields are not editable from the admin panel.

info

coming soon!