Updated on 2024-12-30 GMT+08:00

Managing User Attributes

When an enterprise needs to configure more user information and synchronize it to downstream application systems, you can add and define user attributes. You can set user attributes in the basic information and work information and add custom groups as needed.

  • Basic information: personal attributes, such as username and mobile number. The configured basic attributes cannot be deleted but only added or modified.
  • Work information: work attribute, employee ID, and work location. The configured work information can be added or modified but cannot be deleted.

Adding Basic User Information

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. On the user attribute definition page, choose Settings > Add Field on the right of Basic Information.

  4. On the page for adding a field, enter the field information.

    Table 1 Field information and content

    Parameter

    Description

    * Attribute Name

    The attribute name must be unique.

    * Code

    The attribute code must be unique.

    * Type

    Options vary depending on the attribute type.

    NOTE:
    • If you set Type to Dictionary, select a dictionary. For details about how to add a dictionary, see Dictionaries.
    • If Display Type is set to Sensitive text, the system anonymizes some sensitive text by default. You can select All.

    Field Remarks

    Description of the attribute.

    Field Validation Rules

    Whether an attribute is mandatory and unique, and its length is restricted.

    Table 2 Display settings

    Parameter

    Description

    Administrator Portal

    If you select Display in query conditions, this attribute can be used as a search criterion on the user list page.

    (Administrator) Adding Users

    Indicates whether to display or hide the attribute when a user is added.

    Editing a User as an Administrator

    Indicates whether the administrator is allowed to modify the attribute when the user information is edited.

    Registration information

    Indicates whether to display or hide the attribute when viewing personal information.

    Personal information page

    • You can set whether to display or hide the attribute when viewing personal information.
    • You can set whether to allow users to modify the attributes when modifying personal information.

    Import/Export

    Indicates whether to allow the attribute import or export when importing or exporting users.

  5. Click OK. The attribute is added and displayed in the list.

Adding Work Information

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. On the user attribute definition page, choose Settings > Add Field on the right of Work Information.

  4. On the page for adding a field, enter the field information.

    Table 3 Field information and content

    Parameter

    Description

    *Field Name

    The attribute name must be unique.

    * Attribute Code

    The attribute code must be unique.

    * Field Type

    Options vary depending on the attribute type.

    NOTE:
    • If you set Type to Dictionary, select a dictionary. For details about how to add a dictionary, see Dictionaries.
    • If Display Type is set to Sensitive text, the system anonymizes partial sensitive text by default. You can choose to anonymize all sensitive text.

    Field Remarks

    Description of the attribute.

    Field verification rule

    Whether an attribute is mandatory and unique, and its length is restricted.

    Table 4 Display settings

    Parameter

    Description

    Administrator Portal

    If you select Display in query conditions, this attribute can be used as a search criterion on the user list page.

    (Administrator) Adding Users

    Indicates whether to display or hide the attribute when a user is added.

    Editing a User as an Administrator

    Indicates whether the administrator is allowed to modify the attribute when the user information is edited.

    Registration information collection

    Indicates whether to display or hide the attribute when viewing personal information.

    Profile page

    • You can set whether to display or hide the attribute when viewing personal information.
    • You can set whether to allow users to modify the attributes when modifying personal information.

    Import/Export Jobs

    Indicates whether to allow the attribute import or export when importing or exporting users.

  5. Click OK. The attribute is added and displayed in the list.

Editing a Group

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. On the user attribute definition page, choose Settings > Add Field on the right of Edit Group.

    To edit a work information group, choose Settings > Edit Group on the right of Work Information on the User Attributes page.

  4. After entering the group information, click OK. The group information is edited. When adding a user, the administrator can add field information based on the group.

Adding a Custom Group

If the basic information and work information groups cannot meet your requirements, perform the following steps to add a custom group:

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. On the User Attributes page, click Add Group.
  1. Enter the group name in Chinese and English.
  2. Click OK. The group is added successfully and displayed in the group list.

Deleting a Custom Group

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. On the User Attributes page, choose Settings > Delete Group on the right of the custom group to be deleted, and click OK to delete the custom group.

International Settings

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. On the User Attributes page, click Internationalization Settings.
  4. Click Multi-language Settings in the Operation column on the right of a field to configure the field name or remarks in Chinese and English for the basic information, work information, and custom group attributes.
  5. Click Save to complete the configuration, or click Save and Continue to configure other Chinese and English attributes that are not configured.

Deleting a Custom Attribute

  • Attributes in basic user information and work information cannot be deleted.
  • Deleted custom attributes cannot be recovered. Exercise caution when performing this operation.
  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. Click Delete in the Operation column of the custom attribute.
  4. In the displayed dialog box, click OK to delete the custom attribute.

Modifying User Attributes

The field name, attribute code, and field type cannot be modified.

  1. Log in to the administrator portal.
  2. On the top navigation bar, choose Users > User Attributes.
  3. Click Modify in the Operation column of the basic information, work information, or your own group list to modify user attributes.

  4. Click OK. The user attributes are modified.