User Properties

  • 3 minute(s) read

Each User registered in the DPS comes with a set of predefined properties, and in addition you can define custom properties specific for your application domain.

User's custom properties can be used, for example, to:

  • group/sort/search users;

  • manage additional information, like address, city, zip-code, phone numbers.

For more details about how to use and display properties within the pages, refer to the Referencing Properties article.

Configuring properties

By entering the Properties / User page, you can manage the user properties.

Here, you can define properties available to all users. The below list, displays the default properties and the additional properties for all users.

User predefined properties:

PROPERTY NAME

DESCRIPTION

REFERENCE NAME

First Name

The user first name

firstName

Last Name

The user lastname

lastName

Email

The user email used to access the DPS.

email

Language

The language (e.g. Italian) of the user.

language

Timezone

The timezone (e.g. CEST) associated with the user.

timezone

These properties cannot be deleted, because mandatory for the correct functioning of the DPS application, but you can modify the Label and according to the property also some constraints.

Creating a new user property

To add a new user property, you should:

  1. Press the Add Property button.

  2. Provide the required information.

  3. Press the Save button.

Editing user properties

From the property list, if you click on a property, you will enter the property editing page.

The user property editing page is subdivided into the following sections.
Note, that depending on the selected property, the editing page may be different.

General

  • Label: the label displayed within the pages (e.g. Foo Bar).

  • Name: the property simple name used to reference it within templates and APIs (e.g. properties.fooBar)

  • Description: the description that is displayed under the properties within the editing pages.

  • Type: the property value type, one of Address, Boolean, City, Contacts, Date, Double, Email, File, Fiscal Code, Float, Integer, Long, Mobile Number, Phone Number, State, Street Number, String, Zip Code.
    For more details about types, refer to the Property Types article.

  • Unit: the unit displayed along with the property value (e.g. Kg). It is available only for numeric properties.

  • Default value: the property default value assigned to a newly created object.

  • Data Type: in case of numeric values, you can define whether the property values are DISCRETE or CONTINUOUS, and then you can also define Dictionary and Thresholds.

  • Group: the key used to group properties within editing dialogs.

Rendering

  • Order: the order used to sort properties within editing dialogs.

  • Selection: the selection mode (radio, select, switch) for multiple values.

  • Values: the set of value and label pairs in case of selection.

Constraints

  • Unique: it is not possible to have two objects with the same property value. If you try to create a new object or update an existing one, using the value already saved in another object, the backend will report an error.

  • Mandatory: the property cannot be left blank. When creating a new object or updating an existing object, if the value of the property is missing, the backend reports an error.

  • Limit write permissions depending on the user-type: you can limit the user-types can write the property value. If a user which is not authorized to the property, try to write it, the backend reports an error. Properties that are not writable by a user type are also not visible on the edit page of that object in the DPS application.

  • RegEx Validation: you can specify a regular expression (e.g. ([a-z])*)to validate STRING properties.
    Optionally, you can also define the error message to inform the user in case of wrong values.

  • Min: the minimum value used to validate numeric properties.

  • Max: the maximum value used to validate numeric properties.

  • Provided during activation: if selected, when creating a new user, you can avoid providing all the information, even if it is mandatory, and let it be filled in by the newly created user when the account is activated.

Options

  • Notify users on property value update: the user will be notified if the property is updated.