# Configuration and Functionality
# Functionality
The user registration process starts with action "Register" on the login screen:
User part:
- Users need to fill a three-page form with their data and assign a secure password according to the system's password policy (details).
- After completing the registration, they will receive an e-mail to verify their given e-mail address.
In the system, a new registration request is created in module User Registration
.
Admin part:
- As soon as a user verified their e-mail address, authorized user(s) receive an e-mail with a link to the registration request in module
User Registration
. - In this module, they can accept/decline a request.
- After a request was accepted, new users receive a confirmation e-mail and can log in to the system.
Look for further technical information here.
# Configuration
For the user registration to work, you need to make the following settings after installation/restart:
- Decide for one or more user(s) that will manage registration requests. They will receive an e-mail containing a link to module
User Registration
. - If required, add a support e-mail address. It is given in the first e-mail a requesting user receives.
These settings can be done in admin snap-in User Registration
.
- Set the module access of module
User Registration
to "yes" for all roles required (default: no). - If required, set the main menu entry of module
User Registration
to "yes" for all roles required (default: no) - more details.
This can be done in the role-based module settings (opens new window).
# Admin Snap-In User Registration
Admins can enable the user registration and make general settings in admin snap-in General system configurations/User settings/User Registration
:
Field | Description |
---|---|
Enable user registration | Enabled by default. If disabled, the action is not displayed on the login screen. |
Use e-mail address as username | If enabled, the e-mail address entered is automatically taken as the username. |
Create contact from user | If enabled, new users will automatically be created as a contacts. Will be ignored if 4App Essentials is not installed. |
Use captcha for challenge-response test | Enabled by default. If disabled, no captcha will be displayed. |
Authorize user as administrator | Single users can be assigned for receiving registration requests via e-mail. It contains a link to module User Registration . |
Authorize all users in role as administrators | A complete role and their users can be assigned for receiving registration requests via e-mail. It contains a link to module User Registration . |
Roles allowed for user mapping | Only roles selected here can be assigned during authorization of new users. If empty all roles are allowed. |
Support e-mail address | If an e-mail address is set here, it will appear as support contact in the verification e-mail sent to registering users. Replaces {$support_mail} in templates. |
Do not allow existing user information | If selected, these fields from module user will be compared with new registration entries. Duplicates are not allowed and users are requested to enter another value.Unique constraint for username is always checked. |
Field mapping with the user module | Here the fields from user_registr are mapped to the metadata fields from module user . Click + to add a new mapping.Always mapped are: username , lang , password , email |
Make sure to save and reload the system so your changes apply.
# Module User Registration
Module User Registration
(user_registr
) stores and lists all registration requests that were performed via action "Register". All requests have a status and can be accepted/declined here:
As soon as a user completed and sent their registration form, a new entry is created for their request here. Users with access to this module can now check the status of a request. The possible statuses of a request are:
- Initial
- Email address verified
- Accepted user registration
- Denied user registration
# Main Menu Entry
Module User Registration
is not displayed in the main menu by default. It should only be enabled in the main menu if all users of a role are authorized to manage registration requests.
However, it is not required to set the main menu entry of this module to "yes" in order to access/use the module. Single authorized users can access module and registration requests via the e-mail links. That way, you do not have to enable module User Registration
for all other users of that role.
Of course, if all users of a role are authorized to manage registration requests, you can enable the main menu entry for the entire role.
# Password Policy
During registration, potential new users also set their password. The policy follows the rules set in admin snap-in General system configurations/User settings/Security
. These rules show to users when hovering over the i
button next to the form's password field.