Overview
User Management Module can hold the items that represent users on site, keeping them synchronized. You can refer to user items as to regular items by module links and use all advantages of the functionality available for module links.
Please, note!
For the system versions prior to 9.96, User Management Module needs to be enabled for a specific site in System.properties file:
enableModuleForUserManagement = [*] | [SiteID]
Use comma separated list of site ids for which Module for User management can be configured or * for all sites. When enabled, the corresponding menu will be available in Site Configuration > User Settings > Custom User Attributes.
In versions 9.96 and later, user management module is always enalbed.
Configuration
Follow these steps to configure the functionality:
1. Create a new module with a predefined structure for user management using module template “Users” available in Site Configuration > Modules > Create Module window on site you previously enabled for User management.
2. Map created module to User list on site in Site Configuration > User Settings > Custom User Attributes.
3. After saving the configuration all the users on site will be copied to the User Management module. This can take several minutes on large databases, the progress indicator will show how many users are copied at the moment.
When user synchronization is done the User management module will contain all users present on site (active and inactive) and will reflect all changes made for users in Site and System Configuration (update, activation, reactivation, expiration etc.).
User management module can be used as a source of module link values for the module links in other modules, providing full set of standard module link functionality (prefilling, autofilling etc.).
You are free to manually add custom fields of any type to the User management module to extent user information. Additional custom fields from this module can be edited from User Edit window.
Changes made directly in User management module (not in User Edit window) are applied for users on site, but it is not recommended to do because of some limitations:
It is possible to create only inactive user from the user management module.
Mobile Email field in user management module allows to keep non-unique emails (the setting “Don’t allow duplicates” is disabled by default).
User in the module will not be inactivated immediately in case of deleting his Access Right or coming of Expiration period. Though he will be correspondingly updated (inactivated) automatically by service background task which is scheduled to run every 6 hours starting from the 00:00.
Note! User management module is created with three dedicated execute task actions of special type “Update users” which are required to handle the synchronization of users. Do not remove them in order to keep functionality working.
User field type as module link
When User management module is activated and configured on site, you might want to replace User fields with the links to User module in order to get additional flexibility in configuration (see more about fields in Field Definitions chapter). the new “User Field Conversion” menu is available in Site Configuration > Users Configuration menu. In this menu it is possible to select the needed User fields and start the conversion to User Management module links. Converted fields will become exactly of the module link type with all specific functionality. Field values and pre-filling and filtering settings configured for the field will be kept.
