Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

We are looking at this feature as the first candidate to leverage the new ‘properties’ concept that Joram Wilander has been working on.

Configuring custom user properties

In the system console, a new view is proposed under Site Configuration > System properties. This will house configuration for customizing properties for users, messages, and cards.

To start, we’ll focus on user properties.

image-20240620-181217.pngImage Modified

Standard user properties

Every Mattermost server has as set of standard user properties. These properties cannot be removed.

  • Profile Image (no visibility options)

  • Full Name (visibility default: Always show)

  • Username (visibility default: Always show)

  • Email (visibility default: Hide when empty)

  • ID (visibility default: Always hide)

The following configuration is available for standard user properties

  • Visibility - admins can hide/show the property from user profiles (see below)

  • Link/unlink SAML or ADLDAP (if setup)

Custom user properties

Default custom user properties

By default, the following optional properties ship with user profiles. These properties can be removed or edited as needed. Additional properties can also be added here (see ‘Adding a new property’ below).

  • Nickname

  • Position

Adding a new custom user property

Under the Custom user properties section, users can click the + Add property button to add a new property to the system.

Re-ordering custom properties

Each row in the custom properties table can be dragged to re-order. Re-ordering here will change the order properties are displayed in the user profile.

Note

NOTE: Standard properties cannot be re-ordered.

image-20240620-194040.pngImage Modified

Editing a property

Editing property name

Clicking on the property name in the table enables users to edit the name inline.

image-20240620-194304.pngImage Modified
Note

Note: User property names must be unique.

Editing property type

Custom properties can be clicked to open up the types menu to change the property type. This menu is searchable.

image-20240620-194339.pngImage Modified

Editing property options

Admins can set predefined options for a property with Select, and Multi-Select property types. Admins can add and remove options directly in this configuration table.

image-20240620-185913.pngImage Modifiedimage-20240620-190149.pngImage Modified

More settings and actions

...

image-20240620-195649.pngImage Added

  • Rename:Sets focus on the name cell

  • Edit property type: Sets focus on the type cell and shows the type menu

  • Visibility: Choose whether the property shows in user profiles. Available options are:

    • Always show

    • Always hide

    • Hide when empty (default)

  • Allow new options: Choose whether end users can add new options for the property. This is only available for Select or Multi-Select property types.

  • Duplicate property: Creates a copy of the property with the same configuration and adds to the bottom of the table. Appends ‘2’ to the end of the property name.

  • Link to SAML or AD/LDAP: If SAML or ADLDAP are configured on the server, this option will be available and user properties can be linked.

Linking a property to SAML or ADLDAP attribute

If the server is already configured with AD/LDAP or SAML sync, then the menu option to link a property becomes available.

image-20240620-200437.pngImage Added

Upon clicking this menu option, a modal opens to link the property with the AD/LDAP or SAML attribute.

image-20240620-194521.pngImage Modified

When a value is entered, the attribute is checked and validated with AD/LDAP (or SAML).

image-20240620-200530.pngImage Added

When a property is linked, it will show ‘Linked with AD/LDAP’ in the row

image-20240620-200630.pngImage Added


Displaying custom properties in the profile popover

Webapp

Standard properties will have reserved slots in the popover, while custom properties will display directly below the ‘Email’ property.

image-20240620-200926.pngImage Added

image-20240620-200910.pngImage Added

Mobile

image-20240620-201127.pngImage Added
image-20240620-201132.pngImage Added

Custom properties in the profile settings modal

Webapp

image-20240620-201215.pngImage Addedimage-20240620-201233.pngImage Added

Mobile